├── _posts
    ├── .gitkeep
    ├── 2015-09-25-general-usage.md
    ├── 2018-05-12-audit.md
    ├── 2015-09-25-winapp2ini.md
    ├── 2018-03-14-troubleshooting.md
    ├── 2019-08-14-chaff.md
    ├── 2015-09-30-install-on-windows.md
    ├── 2019-04-19-contributing.md
    ├── 2019-04-19-variables.md
    ├── 2015-09-25-preferences.md
    ├── 2015-09-25-running-from-source-code.md
    ├── 2015-09-25-command-line-interface.md
    ├── 2015-09-30-install-on-linux.md
    ├── 2015-09-25-cleanerml.md
    ├── 2021-04-17-testing.md
    ├── 2015-09-25-frequently-asked-questions.md
    └── 2015-09-25-shred-files-and-wipe-disks.md
├── CNAME
├── _includes
    ├── footer.html
    ├── ad.html
    ├── header.html
    ├── google_analytics.html
    ├── navigation.html
    └── disqus.html
├── .gitignore
├── images
    ├── debug-windows10.png
    ├── run-dialog-windows10.png
    └── windows-10-verified-publisher-certum.png
├── Gemfile
├── _layouts
    ├── page.html
    └── default.html
├── README.md
├── index.md
├── css
    ├── main.css
    └── syntax.css
├── _config.yml
├── bin
    └── jekyll-page
└── COPYING


/_posts/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/CNAME:
--------------------------------------------------------------------------------
1 | docs.bleachbit.org
2 | 


--------------------------------------------------------------------------------
/_includes/footer.html:
--------------------------------------------------------------------------------
1 | <!-- footer -->
2 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.sw?
2 | _site
3 | _pages
4 | *~
5 | 


--------------------------------------------------------------------------------
/images/debug-windows10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bleachbit/docs/HEAD/images/debug-windows10.png


--------------------------------------------------------------------------------
/images/run-dialog-windows10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bleachbit/docs/HEAD/images/run-dialog-windows10.png


--------------------------------------------------------------------------------
/images/windows-10-verified-publisher-certum.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bleachbit/docs/HEAD/images/windows-10-verified-publisher-certum.png


--------------------------------------------------------------------------------
/_includes/ad.html:
--------------------------------------------------------------------------------
1 | <script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-5529386520795320"
2 |      crossorigin="anonymous"></script>
3 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
 1 | source "https://rubygems.org"
 2 | 
 3 | #https://talk.jekyllrb.com/t/liquid-4-0-3-tainted/7946/12
 4 | 
 5 | gem 'liquid', '>= 4.0', '< 6.0'
 6 | gem 'jekyll', '>= 4.3.2'
 7 | gem 'jekyll-redirect-from'
 8 | 
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/_layouts/page.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: default
 3 | ---
 4 | 
 5 | <div class="page-header">
 6 |     {% include ad.html %}
 7 |     <h2>{{ page.title }}
 8 |         {% if page.subtitle %}<small>{{ page.subtitle }}</small>{% endif %}
 9 |     </h2>
10 | 
11 | {{ content }}
12 | 


--------------------------------------------------------------------------------
/_includes/header.html:
--------------------------------------------------------------------------------
 1 | <h4><a class="brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
 2 |     {% if site.subtitle %}<small>{{ site.subtitle }}</small>{% endif %}
 3 | </h4>
 4 | 
 5 | <p><a href="https://www.bleachbit.org">Main site</a>
 6 |  | <a href="https://www.bleachbit.org/download">Download</a>
 7 |  | <a href="https://www.bleachbit.org/help">Get Help</a>
 8 |  | <a href="https://github.com/bleachbit/docs">Edit this documentation</a>
 9 |  </p>
10 | 
11 | 
12 | 
13 | 


--------------------------------------------------------------------------------
/_includes/google_analytics.html:
--------------------------------------------------------------------------------
 1 | <script>
 2 |   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 3 |   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 4 |   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 5 |   })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 6 | 
 7 |   ga('create', '{{ site.google_analytics_id }}', 'auto');
 8 |   ga('send', 'pageview');
 9 | </script>
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # BleachBit Documentation
 2 | 
 3 | Are you a user wanting to learn how to use BleachBit? [Read the documentation.](https://docs.bleachbit.org/)
 4 | 
 5 | # Build
 6 | 
 7 | ```sh
 8 | sudo apt-get update
 9 | sudo apt-get install gnupg2 ruby jekyll bundle
10 | sudo apt-get remove ruby-liquid # in case installed earlier
11 | bundle install
12 | bundle exec jekyll serve
13 | bundle exec jekyll build
14 | ```
15 | 
16 | # Help improve
17 | 
18 | 1. Log in to GitHub.
19 | 2. Fork this repository to make your own copy.
20 | 3. Make the edits in your own repository.
21 | 4. Submit a pull request to merge your changes.
22 | 
23 | # License
24 | 
25 | The documentation is under the GNU General Public License version 3 or later
26 | 


--------------------------------------------------------------------------------
/_includes/navigation.html:
--------------------------------------------------------------------------------
 1 | <ul class="nav nav-list">
 2 |     <li><a href="{{ site.baseurl }}/">Home</a></li>
 3 |     {% for section in site.sections %}
 4 |         {% assign attr = section[0] %}
 5 |         {% assign label = section[1] %}
 6 | 
 7 |         {% for page in site.categories[attr] %}
 8 |             {% if forloop.first %}
 9 |                 <li class="nav-header">{{ label }}</li>
10 |             {% endif %}
11 |             <li data-order="{{ page.order }}"><a href="{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a></li>
12 |         {% endfor %}
13 |     {% endfor %}
14 | <!-- List additional links. It is recommended to add a divider
15 |     e.g. <li class="divider"></li> first to break up the content. -->
16 | </ul>
17 | 


--------------------------------------------------------------------------------
/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: default
 3 | title: "BleachBit Documentation"
 4 | redirect_from: "/doc/install.html"
 5 | ---
 6 | 
 7 | ### BleachBit
 8 | 
 9 | This is the manual for [BleachBit](https://www.bleachbit.org), a fast and safe system cleaner. By simply checking boxes, you can delete unnecessary files such as cache, logs, cookies, recently-used-files lists, and more.
10 | 
11 | Use the navigation on left to browse the documentation.
12 | 
13 | ![BleachBit 1.9.3 on Windows 10](https://lh3.googleusercontent.com/-ZHs6M_r9odI/VnbrV7sK1cI/AAAAAAAAD6A/WBdTf4DUVbs/s800-Ic42/BleachBit%2525201.9.3%252520on%252520Windows%25252010%252520showing%252520Firefox%252520preview.png "The main screen of BleachBit 1.9.3 on Windows 10")
14 | 
15 | [Edit this documentation](https://github.com/bleachbit/docs) on GitHub.
16 | 


--------------------------------------------------------------------------------
/_includes/disqus.html:
--------------------------------------------------------------------------------
 1 | <div id="disqus_thread"></div>
 2 | <script type="text/javascript">
 3 |     /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
 4 |     var disqus_shortname = '{{ site.disqus_shortname }}'; // required: replace example with your forum shortname
 5 | 
 6 |     /* * * DON'T EDIT BELOW THIS LINE * * */
 7 |     (function() {
 8 |         var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
 9 |         dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
10 |         (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
11 |     })();
12 | </script>
13 | <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
14 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-general-usage.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "General Usage"
 4 | category: doc
 5 | date: 2015-09-25 23:25:52
 6 | order: 3
 7 | ---
 8 | 
 9 | The general usage is as follows:
10 | 
11 | 1.  Notice on the left of the main window is a list of cleaners and options. (Each cleaner has one or more options.)
12 | 2.  Click on the label of the cleaner that interests you. (The label is the text next to the checkbox.)
13 | 3.  Read the cleaner's description (which appears on the right).
14 | 4.  Check any options you want to clean.
15 | 5.  _Close any applications you will be cleaning._ For example, you should not clean Firefox while Firefox is running.
16 | 6.  Click the **Preview** button, and review the list of files. The preview button is "safe" and makes no changes to your system.
17 | 7.  Make any adjustments to your selection of options, and preview again until you are comfortable with the changes. Disable any options which you don't understand or make you uncomfortable.
18 | 8.  Click the **Delete** button.
19 | 
20 | Watch the [videos](https://www.bleachbit.org/videos) for narrated walk-through of usage.
21 | 
22 | 
23 | 


--------------------------------------------------------------------------------
/css/main.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |     font-weight: 400;
 3 |     text-shadow: 0 1px 1px rgba(255, 255, 255, 0.7);
 4 | }
 5 | 
 6 | pre, code {
 7 |     border: none;
 8 |     border-radius: 0;
 9 |     background-color: #f9f9f9;
10 |     font-size: 0.85em;
11 | }
12 | 
13 | pre {
14 |     font-size: 1em;
15 | }
16 | 
17 | code {
18 |     color: inherit;
19 | }
20 | 
21 | #header {
22 |     border-bottom: 1px solid #eee;
23 |     margin-bottom: 20px;
24 | }
25 | 
26 | #header a:hover {
27 |     text-decoration: none;
28 | }
29 | 
30 | #footer {
31 |     margin: 20px 0;
32 |     font-size: 0.85em;
33 |     color: #999;
34 |     text-align: center;
35 | }
36 | 
37 | #content > .page-header:first-child {
38 |     margin-top: 0;
39 | }
40 | 
41 | #content > .page-header:first-child h2 {
42 |     margin-top: 0;
43 | }
44 | 
45 | 
46 | #navigation {
47 |     font-size: 0.9em;
48 | }
49 | 
50 | #navigation li a {
51 |     padding-left: 10px;
52 |     padding-right: 10px;
53 | }
54 | 
55 | #navigation .nav-header {
56 |     padding-left: 0;
57 |     padding-right: 0;
58 | }
59 | 
60 | body.rtl {
61 | 	direction: rtl;
62 | }
63 | 
64 | body.rtl #header .brand {
65 | 	float: right;
66 |     margin-left: 5px;
67 | }
68 | body.rtl .row-fluid [class*="span"] {
69 | 	float: right !important;
70 | 	margin-left: 0;
71 | 	margin-right: 2.564102564102564%;
72 | }
73 | body.rtl .row-fluid [class*="span"]:first-child {
74 | 	margin-right: 0;
75 | }
76 | 
77 | body.rtl ul, body.rtl ol {
78 |     margin: 0 25px 10px 0;
79 | }
80 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
 1 | # Site title and subtitle. This is used in _includes/header.html
 2 | title: BleachBit Documentation
 3 | #subtitle: 'Documentation for BleachBit'
 4 | 
 5 | # if you wish to integrate disqus on pages set your shortname here
 6 | disqus_shortname: ''
 7 | 
 8 | # if you use google analytics, add your tracking id here
 9 | google_analytics_id: ''
10 | 
11 | # Enable/show navigation. There are there options:
12 | #   0 - always hide
13 | #   1 - always show
14 | #   2 - show only if posts are present
15 | navigation: 2
16 | 
17 | # URL to source code, used in _includes/footer.html
18 | #codeurl: 'https://github.com/bruth/jekyll-docs-template'
19 | 
20 | # Default categories (in order) to appear in the navigation
21 | sections: [
22 |     ['doc', 'Documentation'],
23 |     ['tut', 'Tutorial'],
24 |     ['ref', 'Reference'],
25 |     ['cml', 'CleanerML'],
26 |     ['dev', 'Developers'],
27 |     ['post', 'Posts']
28 | ]
29 | 
30 | # Keep as an empty string if served up at the root. If served up at a specific
31 | # path (e.g. on GitHub pages) leave off the trailing slash, e.g. /my-project
32 | baseurl: ''
33 | 
34 | # Dates are not included in permalinks
35 | permalink: none
36 | 
37 | # Syntax highlighting
38 | highlighter: rouge
39 | 
40 | # Since these are pages, it doesn't really matter
41 | future: true
42 | 
43 | # Exclude non-site files
44 | exclude: ['bin', 'README.md']
45 | 
46 | # Use the kramdown Markdown renderer
47 | markdown: kramdown
48 | redcarpet:
49 |     extensions: [
50 |         'no_intra_emphasis',
51 |         'fenced_code_blocks',
52 |         'autolink',
53 |         'strikethrough',
54 |         'superscript',
55 |         'with_toc_data',
56 |         'tables',
57 |         'hardwrap'
58 |     ]
59 | 
60 | # https://help.github.com/articles/redirects-on-github-pages/
61 | plugins:
62 |   - jekyll-redirect-from
63 | 
64 | 


--------------------------------------------------------------------------------
/_posts/2018-05-12-audit.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Audit"
 4 | category: dev
 5 | date: 2018-05-12 15:38:24
 6 | ---
 7 | 
 8 | This is one procedure to audit the BleachBit's effectiveness.
 9 | 
10 | ### Prerequisite
11 | 
12 | Make sure you have the latest version of BleachBit. Preferably, it is
13 | the latest version in Git or [the latest CI build](https://ci.bleachbit.org/).
14 | 
15 | ### Google Chrome
16 | 
17 | #### Exercise
18 | 
19 | These steps "exercise" the browser to use all its functionality.
20 | 
21 | 1. Start Google Chrome.
22 | 1. Enable Chrome Sync.
23 | 1. Go to Google Search, and search for a [string of random characters](https://www.random.org/strings/?num=10&len=8&digits=on&upperalpha=on&loweralpha=on&unique=off&format=plain&rnd=new). Make a note of this string for a step below.
24 | 1. On the [Evercookie](https://samy.pl/evercookie/) page, open the Chrome site preferences. Enable Flash, Location, and other site-specific preferences.
25 | 1. Create an Evercookie.
26 | 1. Download a file from any site, and make a note of the filename and download URL.
27 | 1. Run Service Workers ([demo](https://googlechrome.github.io/samples/service-worker/basic/)).
28 | 1. Play media ([demo](https://www.webmfiles.org/demo-files/)). (This is not equivalent to downloading the media.)
29 | 1. Use other functionality in Google Chrome, and make a note of the associated URLs or other strings.
30 | 
31 | #### Clean
32 | 
33 | 1. Close Google Chrome.
34 | 1. Start BleachBit.
35 | 1. In the BleachBit preferences, enable the option *Overwrite contents*.
36 | 1. Use BleachBit to clean all of Google Chrome.
37 | 
38 | #### Audit
39 | 
40 | 1. Use a tool such as `grep` to search the Google Chrome profile folder for the random string (used in Google Search, above), the site address `samy.pl`, and other strings from the exercise phase. There should be no matches.
41 | 1. Start Google Chrome.
42 | 1. Open the browser history (CTRL+H), and there should be none.
43 | 1. Revisit the Evercookie page, and the cookie with the same identifier should not be rediscovered.
44 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-winapp2ini.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Winapp2.ini"
 4 | category: doc
 5 | date: 2015-09-25 23:38:45
 6 | order: 8
 7 | ---
 8 | 
 9 | BleachBit imports cleaning rules from winapp2.ini files giving Windows users 2400+ additional cleaners (and growing) created by the community. [Piriform does not endorse importing "CCleaner data" into BleachBit](https://www.bleachbit.org/news/ccleaner-asks-bleachbit-remove-winapp2ini-importer).
10 | 
11 | If you are writing new cleaner definitions, it is recommended you write them in [CleanerML](cleanerml) instead of winapp2.ini format because CleanerML is cross-platform, not legally encumbered, and contains many features not available in winapp2.ini.
12 | 
13 | ### Automatically import Winapp2.ini
14 | 
15 | Check this box, and restart BleachBit to download the winapp2.ini file. Restart BleachBit again for it to take effect.
16 | 
17 | ![Download and update Winapp2.ini automatically: BleachBit 0.8.8 on Windows 7](https://lh6.googleusercontent.com/-LTmt1E95Ioo/TfgnJN7NiLI/AAAAAAAAC4A/qdNQcmMjpvI/s800/bleachbit-088-windows-7-preferences-general-highlight.png)
18 | 
19 | ### Manually import Winapp2.ini
20 | 
21 | To manually import winapp2.ini cleaners, simply do this:
22 | 
23 | 1.  Download a winapp2.ini file. The CCleaner community organically maintains various files: [winapp2.ini](https://github.com/MoscaDotTo/Winapp2/). This file is not created by endorsed by Piriform, maker of CCleaner. An alternative file [Winapp2.ini plus](https://github.com/bleachbit/winapp2.ini) contains additional entries for BleachBit.
24 | 2.  Place the winapp2.ini file in the right directory, which is most of the same directories as [CleanerML](cleanerml). If you install BleachBit (i.e., non-portable mode), below are the recommended directories. See [CleanerML storage](cleanerml) for more options.
25 |     *   Windows XP: ```C:\Documents and Settings\(username)\Application Data\BleachBit\Cleaners\```
26 |     *   Windows Vista/7: ```C:\Users\(username)\AppData\Roaming\BleachBit\Cleaners\```
27 | 3.  Restart BleachBit.
28 | 
29 | 
30 | 


--------------------------------------------------------------------------------
/_posts/2018-03-14-troubleshooting.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Troubleshooting"
 4 | category: doc
 5 | date: 2000-03-14 21:36:58
 6 | order: 10
 7 | ---
 8 | 
 9 | When something goes wrong, these steps will help you gather information to ask for help or to file a bug report.
10 | 
11 | ## Show system information
12 | 
13 | Sometimes the system information is helpful to include when asking for help, and here is how to find it.
14 | 
15 | 1. Open BleachBit
16 | 2. Click on the Help menu
17 | 3. Click on System Information
18 | 4. Click the Copy button to copy the information the clipboard.
19 | 
20 | Then paste the information in your help request.
21 | 
22 | ## Show the application log
23 | 
24 | ### When installed on Windows 10
25 | 
26 | When BleachBit is installed on Windows 10, use these steps to show logging information in the console. This sets the logging level to the normal level for normal releases, and it sets it to verbose level for beta releases.
27 | 
28 | 1. Click in the Windows search box
29 | 2. Type `debug` to search for it
30 | 2. Click on **BleachBit Debugging Terminal**
31 | 
32 | ![Screenshot showing how to launch the debugging terminal](/images/debug-windows10.png)
33 | 
34 | To make logging more verbose for normal releases or to write the log to a file, instead follow these steps.
35 | 
36 | 1. Hold down the **Windows** key while pressing the **R** button. This brings up the Run dialog.
37 | 2. Type or paste the command `"%ProgramFiles(x86)%\BleachBit\bleachbit_console.exe" --gui --debug-log=%USERPROFILE%\desktop\bleachbit.log`
38 | 3. Click **Run**
39 | 
40 | ![Screenshot of the Windows run dialog](/images/run-dialog-windows10.png)
41 | 
42 | Please note that in the screenshot above, the whole command cannot be seen because it is wider than the field.
43 | 
44 | The log will appear on the desktop, and you will also see it live in the console window.
45 | 
46 | ### On Linux
47 | 
48 | On Linux systems use these steps to show verbose logging information:
49 | 
50 | 1. Open a terminal such as GNOME Terminal
51 | 2. Type or paste the command `bleachbit --gui --debug-log=/home/username/bleachbit.log` (while replacing *username* with your system username)
52 | 
53 | The log will appear in your home directory.
54 | 
55 | ## Where to get help
56 | 
57 | See [BleachBit support](https://www.bleachbit.org/help) to get help.
58 | 


--------------------------------------------------------------------------------
/_posts/2019-08-14-chaff.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Chaff"
 4 | category: doc
 5 | date: 2000-08-14 20:45:26
 6 | ---
 7 | 
 8 | For aircrafts, chaff is a physical countermeasure that confuses radar by making it
 9 | seem like there are additional aircraft in the sky, and chaff protects the aircraft
10 | by misdirecting radar-guided missiles.
11 | 
12 | Likewise, BleachBit version 3 introduces a basic chaff system that creates files to
13 | confuse digital forensics. Think of it also like the metaphor of the needle in the haystack.
14 | The needle represents the files you want to keep private, and the chaff is the haystack that makes
15 | the needle difficult to find because the forensic investigator has more junk to sift through
16 | before finding all the needles.
17 | 
18 | Does this imply that using BleachBit to delete other data, such as browser history,
19 | is counterproductive? No. Use BleachBit to remove any private data you don't want found.
20 | However, there may be private data you decide to keep or forgot to clean, and chaff is
21 | one of an array of options to protect this private data. Of course, please also consider
22 | other options such as encryption!
23 | 
24 | BleachBit uses a statistical model called Markov chains to learn a document as inspiration
25 | and then use it to generate random text that is difficult for an investigator to fingerprint.
26 | At a glance, the chaff files seem to be English, but a closer inspection reveals they are
27 | nonsense, so do not spend much time reading them looking for any wisdom.
28 | 
29 | BleachBit 3.0 comes with two statistical models. The first model was inspired by [Hillary
30 | Clinton's emails as released by the United States Department of State](https://foia.state.gov/Search/Collections.aspx).
31 | Please remember that [FBI documents](https://www.bleachbit.org/press) indicate Clinton's
32 | IT guy used BleachBit to wipe emails from her private server, and now BleachBit can also
33 | do the opposite: generate Clinton's emails.
34 | 
35 | The second model was inspired by [2600: The Hacker Quarterly](https://2600.com), a magazine
36 | of the computer underground, to yield more interesting keywords that might show up on the
37 | forensic investigator's scans.
38 | 
39 | When making chaff files, either leave them undeleted or delete them without shredding
40 | them. Shredding them would remove any trace, which would be counterproductive,
41 | but deleting them without shredding can slow down the forensic investigator.
42 | 
43 | While BleachBit itself does not implement any steganography, a savvy user can consider
44 | hiding private data in the seemingly-useless chaff files. Just this possibility
45 | implies a thorough digital forensics investigation would require examining the contents
46 | of the chaff files rather than whitelisting them.
47 | 
48 | 


--------------------------------------------------------------------------------
/_posts/2015-09-30-install-on-windows.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Install on Windows"
 4 | category: doc
 5 | date: 2015-09-30 20:37:24
 6 | order: 1
 7 | ---
 8 | 
 9 | To install BleachBit, first <a href="https://www.bleachbit.org/download">download</a> the latest installation package for your system.
10 | 
11 | BleachBit version 4 is supported on Windows 10 and 11 (32-bit or 64-bit).
12 | 
13 | #### Standard Installation
14 | 
15 | Most Windows users want the standard installation.
16 | 
17 | First, run the installer, which has a name like <tt>BleachBit-4.6.2-setup.exe</tt>. Then, follow the prompts.
18 | 
19 | Verify the installer comes from the verified publisher shown in the screenshot.
20 | 
21 | ![BleachBit 4.6.2 Windows 10 User Access Control verified publisher](/images/windows-10-verified-publisher-certum.png)
22 | 
23 | #### Portable Use
24 | 
25 | While installation is the typical way of using BleachBit, some users prefer an alternative. They may want to put the application on a removable drive or use it on a system without system permission to run installers, but a downside is that the context menu integration is not supported.
26 | 
27 | To run in portable mode, download the package, which has a name like <tt>BleachBit-4.6.2-portable.zip</tt>. Then use a standard unzip utility to unpack the file. Such a utility is included with Windows: just right-click on the <tt>.zip</tt> file and choose **Extract all files** which creates a new folder.
28 | 
29 | Do not double-click on the <tt>.zip</tt> file.
30 | 
31 | #### Silent Installation
32 | 
33 | Silent installation is for advanced users or system administrators. This feature installs the application without any prompts from the user, and system administrators use it to automate the process of installing an application across many systems.
34 | 
35 | Using BleachBit 4.6.2 as an example, run the following command to install the application for all users. It requires the calling process to have administrator privileges:
36 | 
37 | `BleachBit-4.6.2-setup.exe /S /allusers`
38 | 
39 | To install for only the current user, run this command:
40 | 
41 | `BleachBit-4.6.2-setup.exe /S /currentuser`
42 | 
43 | To omit the desktop shortcut, add `/NoDesktopShortcut` directly after `/S`:
44 | 
45 | `BleachBit-4.6.2-setup.exe /S /NoDesktopShortcut /currentuser`
46 | 
47 | Because the installer is silent, it will not throw an error such as if you forget to choose between `/allusers` and `/currentuser` or if the calling process has insufficient privileges.
48 | 
49 | The `/S` and `/NoDesktopShortcut` switches _are_ case-sensitive.
50 | 
51 | The switch `/NoDesktopShortcut` was added in BleachBit 4.4.1.
52 | 
53 | #### After Installation
54 | 
55 | After installation, review the [preference options](/doc/preferences.html) or skip to [general usage](/doc/general-usage.html).
56 | 


--------------------------------------------------------------------------------
/bin/jekyll-page:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env ruby
  2 | 
  3 | require 'date'
  4 | require 'optparse'
  5 | 
  6 | options = {
  7 |     # Expects to be in the bin/ sub-directory by default
  8 |     :path => File.dirname(File.dirname(__FILE__))
  9 | }
 10 | 
 11 | parser = OptionParser.new do |opt|
 12 |     opt.banner = 'usage: jekyll-page TITLE CATEGORY [FILENAME] [OPTIONS]'
 13 |     opt.separator ''
 14 |     opt.separator 'Options'
 15 |     opt.on('-e', '--edit', 'Edit the page') do |edit|
 16 |         options[:edit] = true
 17 |     end
 18 |     opt.on('-l', '--link', 'Relink pages') do |link|
 19 |         options[:link] = true
 20 |     end
 21 |     opt.on('-p PATH', '--path PATH', String, 'Path to project root') do |path|
 22 |         options[:path] = path
 23 |     end
 24 |     opt.separator ''
 25 | end
 26 | 
 27 | parser.parse!
 28 | 
 29 | title = ARGV[0]
 30 | category = ARGV[1]
 31 | filename = ARGV[2]
 32 | 
 33 | # Resolve any relative links
 34 | BASE_DIR = File.expand_path(options[:path])
 35 | POSTS_DIR = "#{BASE_DIR}/_posts"
 36 | PAGES_DIR = "#{BASE_DIR}/_pages"
 37 | 
 38 | # Ensure the _posts directory exists (we are in the correct directory)
 39 | if not Dir.exists?(POSTS_DIR)
 40 |     puts "#{POSTS_DIR} directory does not exists"
 41 |     exit
 42 | end
 43 | 
 44 | # Create _pages directory if it doesn't exist
 45 | if not Dir.exists?(PAGES_DIR)
 46 |     Dir.mkdir(PAGES_DIR)
 47 | end
 48 | 
 49 | if options[:link]
 50 |     Dir.foreach(POSTS_DIR) do |name|
 51 |         next if name[0] == '.'
 52 |         nodate = name[/\d{4}-\d{2}-\d{2}-(?<rest>.*)/, 'rest']
 53 |         if File.symlink?("#{PAGES_DIR}/#{nodate}")
 54 |             File.delete("#{PAGES_DIR}/#{nodate}")
 55 |         end
 56 |         abspath = File.absolute_path("#{POSTS_DIR}/#{name}")
 57 |         File.symlink(abspath, "#{PAGES_DIR}/#{nodate}")
 58 |     end
 59 | end
 60 | 
 61 | if not title or not category
 62 |     # This flag can be used by itself, exit silently if no arguments
 63 |     # are defined
 64 |     if not options[:link]
 65 |         puts parser
 66 |     end
 67 |     exit
 68 | end
 69 | 
 70 | if not filename
 71 |     filename = title.downcase.gsub(/[^a-z0-9\s]/, '').gsub(/\s+/, '-')
 72 | end
 73 | 
 74 | today=Date.today().strftime('%F')
 75 | now=DateTime.now().strftime('%F %T')
 76 | 
 77 | filepath = "#{POSTS_DIR}/#{today}-#{filename}.md"
 78 | symlink = "#{PAGES_DIR}/#{filename}.md"
 79 | 
 80 | if File.exists?(filepath)
 81 |     puts "File #{filepath} already exists"
 82 |     exit
 83 | end
 84 | 
 85 | content = <<END
 86 | ---
 87 | layout: page
 88 | title: \"#{title}\"
 89 | category: #{category}
 90 | date: #{now}
 91 | ---
 92 | 
 93 | 
 94 | END
 95 | 
 96 | File.open(filepath, 'w') do |file|
 97 |     file.puts content
 98 | end
 99 | 
100 | File.symlink("../_posts/#{today}-#{filename}.md", symlink)
101 | 
102 | if options[:edit]
103 |     if not ENV['EDITOR']
104 |         puts 'No $EDITOR variable set'
105 |         exit
106 |     end
107 |     puts ENV['EDITOR']
108 |     exec("#{ENV['EDITOR']} #{filename}")
109 | end
110 | 


--------------------------------------------------------------------------------
/_posts/2019-04-19-contributing.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Contributing"
 4 | category: cml
 5 | date: 2000-01-01 00:00:00
 6 | ---
 7 | 
 8 | Write your own cleaners to use yourself and to share with others. These cleaners define which files to delete or perform some other action.  BleachBit includes one cleaner each for Firefox, Google Chrome, and so on.
 9 | 
10 | ### Writing the cleaner
11 | 
12 | First, follow the [CleanerML documentation](/cml/cleanerml.html) for technical instructions on writing the cleaner.
13 | 
14 | 
15 | ### Testing the cleaner
16 | Backup any files which may be deleted before testing. Then, use this checklist for testing your cleaner:
17 | 
18 | * BleachBit should not delete settings that the user may regret.
19 | * BleachBit is not an uninstaller.
20 | * Each option accurately describes what it will delete.  For example, an option labeled "logs" should not delete cache.
21 | * The descriptions are generic and reuse strings, so translators have less work.  For example, Firefox should simply be labeled "Web browser" instead of "A popular, fast, free web browser." Look at other cleaners to see which strings they use.
22 | * Use [variables](/cml/variables.html) rather than hard-coding paths.
23 | * Run BleachBit in a console window (`bleachbit_console.exe` on Windows) to check for any warnings.
24 | 
25 | ### Submitting the cleaner
26 | To share the cleaner with others, submit it for review:
27 | 
28 | * Do not submit cleaners as your own in which you copied and pasted other's work.  You must own the copyright.
29 | * You must license the cleaner under the GNU General License Version 3 or later.
30 | * Submit the cleaner to [cleanerml on GitHub](https://github.com/bleachbit/cleanerml) as an issue (with a link to a gist) or pull request.
31 | * Identify the platform you tested (for example, Ubuntu 9.04 or Windows Vista).
32 | * Identify the application version tested (for example, Firefox 3.0.10).
33 | * (optional) Describe how much space each option cleans. For example, "the log option deleted 2KB."
34 | * (optional) Identify the home page of the application.
35 | 
36 | Then, wait for a review. Until the final publication, remember you can add the cleaner to your own collection for immediete use in BleachBit.
37 | 
38 | 
39 | ### Reviewing a cleaner
40 | 
41 | Help review another person's cleaner submission.  Because there are so many applications, versions of applications, differences in operating systems, etc., the help of the community is essential.
42 | 
43 | Look in [GitHub](https://github.com/bleachbit/cleanerml) and review them
44 | 
45 | * Be polite.
46 | * Review the testing guidelines, written above.
47 | * Check each option individually.
48 | * In GitHub on the pull request, document your results.  Example reviews:
49 | 
50 | > "I tested gFTP 2.0.18 on Fedora 10.  The cleaner removed 2KB of logs and 500KB of cache.  It did not remove any settings.  I recommend changing the description from "FTP client" to "File transfer client," so it shares the same description with Azureus for ease of translating. Otherwise I recommend the cleaner for publication."
51 | 
52 | > "I tested gFTP 2.0.18 on Fedora 10.  It deleted my settings."
53 | 
54 | 
55 | 


--------------------------------------------------------------------------------
/_posts/2019-04-19-variables.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Variables"
 4 | category: cml
 5 | date: 2000-01-01 00:00:00
 6 | ---
 7 | 
 8 | BleachBit supports several kind of variables for use in writing cleaning rules.
 9 | It is a best practice to use variables rather than hard-coding paths that vary
10 | across systems. Common paths may change depending on user logged in, the version
11 | of Windows, and on the user's language. For example, the Windows `%ProgramFiles%`
12 | is usually on the `C:` drive, but on some systems it is on the `D:` drive.
13 | 
14 | Use variables in any part of CleanerML and Winapp2.ini that refers to a file path.
15 | 
16 | ### Home
17 | 
18 | Write `~` to refer to the user's profile directory. While this is a
19 | Unix convention, BleachBit supports it also on Windows.
20 | 
21 | Example: `~/.bashrc`
22 | 
23 | 
24 | ### Environment variables
25 | 
26 | Use any environment variables defined in the operating system.
27 | 
28 | On Unix systems, BleachBit supports the styles `$foo$` and `${foo}`.
29 | It is a best practice to use the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables).
30 | 
31 | Example: `$XDG_CONFIG_HOME/google-chrome`
32 | 
33 | On Windows, BleachBit supports the Unix-style above and the Windows-style `%foo%`.
34 | 
35 | Example: `%LocalAppData%\Google\Chrome\User Data`
36 | 
37 | The most common Windows environment variables are `%AppData%`, `%LocalAppData%`, `%ProgramFiles%`, and `%UserProfile%`. For more information, see Wikipedia's article ["Environment variable"](https://en.wikipedia.org/wiki/Environment_variable).
38 | 
39 | 
40 | #### Defined by BleachBit
41 | 
42 | In addition to the environment variables defined by the operating system,
43 | BleachBit defines enviroment variables for convenience and compatability.
44 | 
45 | ##### Linux
46 | On Linux, these variables are defined if they do not exist:
47 | 
48 | * `XDG_DATA_HOME`: typically `~/.local/share`
49 | * `XDG_CONFIG_HOME`: typically `~/.config`
50 | * `XDG_CACHE_HOME`: typically `~/.cache`
51 | 
52 | ##### Windows
53 | On Windows, the following are defined if they do not exist:
54 | 
55 | * `cd`: current directory
56 | * `CommonAppData`
57 | * `Documents`
58 | * `LocalAppData`
59 | * `LocalAppDataLow`
60 | * `Music`
61 | * `Pictures`
62 | * `Video`
63 | 
64 | The variable `%ProgramFiles%` can behave in an unexpected way because 64-bit
65 | Windows will modify it for 32-bit applications, and BleachBit is a 32-bit
66 | application. To refer to the 64-bit folder on 64-bit Windows, use `%ProgramW6432%`
67 | instead. For more information, see Microsoft's article ["WOW64 Implementation Details"](https://docs.microsoft.com/en-us/windows/desktop/winprog64/wow64-implementation-details).
68 | 
69 | For compatibility with Winapp2.ini, BleachBit expands `%ProgramFiles%` to
70 | `%ProgramW6432%` as if both were written. Likewise, BleachBit expands
71 | `%CommonProgramFiles%` to `%CommonProgramW6432%`. This expansion is not
72 | supported in CleanerML.
73 | 
74 | #### Multi-value variables
75 | 
76 | BleachBit 2.2 introduces to CleanerML a feature called multi-value variables. Within each cleaner, a variable can be defined with multiple values. This greatly simplifies the development and maintenance of cleaners with path variations for operating system and for application derivatives such as Google Chrome and Chromium.
77 | 
78 | The syntax to use a multi-value variable is `$$foo$$` on both Linux and Windows. Multi-value variable names are case-sensitive, and values can contain environment variables. See the Adobe Flash cleaner (`flash.xml`) for a basic example.
79 | 
80 | BleachBit 3.0 introduces default variables on Windows
81 | 
82 | * `$$ProgramFiles$$` expands to both `%ProgramFiles%` and `%ProgramW6432%`
83 | * `$$CommonProgramFiles$$` expands both `%CommonProgramFiles%` and `%CommonProgramW6432%`
84 | 
85 | 
86 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-preferences.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: "Preferences"
 4 | category: doc
 5 | date: 2015-09-25 23:17:25
 6 | order: 2
 7 | ---
 8 | 
 9 | BleachBit provides preferences (also called options or settings) which change how it works. To edit the preferences, click **Edit** - **Preferences**.
10 | 
11 | ### Check periodically for updates via the Internet
12 | 
13 | When enabled, BleachBit checks for updates. If an update is found, a notification button appears. Click the button to read about the changes and download the new version. The new version is _not_ downloaded automatically.
14 | 
15 | ### Hide irrelevant cleaners
16 | 
17 | Enabling this option reduces clutter at the cost of a slightly longer startup.
18 | 
19 | BleachBit determines whether a cleaner is relevant two ways: first, it checks whether there is anything to clean. For example, it only checks that Firefox has cache, but it doesn't check whether Firefox is installed. (This works well for applications you used once and then deleted.) Second, BleachBit checks whether the cleaner was already enabled: enabled cleaners are not hidden.
20 | 
21 | If a cleaner has a deep scan option, it is not hidden.
22 | 
23 | ### Overwrite contents of files to prevent recovery
24 | 
25 | When files are deleted normally, the operating system only deletes the _reference_ to the file (not the _contents_), but later file can usually be undeleted. To securely delete files marked for cleaning (such as Firefox cache) to prevent this kind of recovery, enable overwriting files (also called file shredding).
26 | 
27 | Overwriting files is significantly slower than deleting files normally. Overwriting is supported for standard file deletions (such as deleting Firefox cache) and when deleting Firefox URL history (a special operation), but it is not supported for other special operations (such as deleting locked files in Windows). Overwriting is not effective with some situations such as the Linux ext3 and ext4 filesystems in `data=journal` mode. On Ubuntu the default is `data=ordered` mode which is effective to overwrite.
28 | 
29 | Since BleachBit 2.0 when running with administrator privileges, wiping compressed files on NTFS is effective.
30 | 
31 | To complement the limitations of overwriting individual files, use the **Free disk space** option under **System** to overwrite free disk space and hide previously deleted files.
32 | 
33 | ### Exit after cleaning
34 | 
35 | When this option is enabled and when the cleaning is done, the application will close itself.
36 | 
37 | ### Confirm before delete
38 | 
39 | When this option is enabled, the cleaning button requires a confirmation prompt before making changes.
40 | 
41 | ### Use IEC sizes
42 | 
43 | This option affects only how sizes are reported, and it does not affect how the application functions. When enabled, one KiB is 1000 bytes. When disabled, 1 kB is 1000 bytes.
44 | 
45 | ### Dark mode
46 | 
47 | When enabled, the application uses a dark theme. When disabled, the application uses a light theme. For a demonstration, see the video: [BleachBit version 2.3 dark mode](https://www.youtube.com/watch?v=kWM4-7X5_1g).
48 | 
49 | ### Show debug messages
50 | 
51 | When enabled, both the GUI and the console will show technical messages that sometimes help trouleshooting. Most users do not need to enable this option.
52 | 
53 | ### Custom
54 | 
55 | In the custom tab, choose a file or folder to delete. It will be deleted only when the Custom option is enabled under the System category.
56 | 
57 | ### Drives
58 | 
59 | Before using the **Free disk space** option under **System**, select a writable directory for each drive (also called logical partition or mount point). The unallocated disk space in the chosen drives will be wiped.
60 | 
61 | When starting for the first time, BleachBit tries to guess the correct value. In Linux, a good setting is typically <tt>/home/(username)</tt> and <tt>/tmp</tt>, but only one should be used if both are on the same partition. In Windows, typically <tt>C:\\</tt> is a good choice.
62 | 
63 | ### Languages
64 | 
65 | Select all languages you wish to keep. If your native language is Klingon, select Klingon. Locale files for unchecked languages will be deleted when cleaning **Localizations** under **System**.
66 | 
67 | This option is not available in Windows.
68 | 
69 | ### Whitelist
70 | 
71 | Files and folders added to the whitelist will be skipped during preview and during cleaning.
72 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-running-from-source-code.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Running from source code"
  4 | category: dev
  5 | date: 2015-09-25 23:40:58
  6 | ---
  7 | 
  8 | Running BleachBit from source code is intended for developers and testers: other users should install [the prepared packages](https://www.bleachbit.org/download). Running BleachBit from source code is relatively easy because there is nothing to compile and installing BleachBit is not required.
  9 | 
 10 | ## Linux
 11 | 
 12 | Linux systems often have the necessary dependencies installed for running BleachBit from source code. 
 13 | 
 14 | ### BleachBit 3.x
 15 | 
 16 | On Debian and Ubuntu, install the `python-gtk2` package. On Fedora, CentOS, and Red Hat, install the `pygtk2` package.
 17 | 
 18 | ### BleachBit 4.x
 19 | 
 20 | On Debian and Ubuntu, install these packages: `gir1.2-gtk-3.0`, `libgtk-3-0`, and `python3-gi`. On Fedora, CentOS, and Red Hat, install `gtk3`, `python3-chardet`, and `python3-gobject`.
 21 | 
 22 | 
 23 | ## Microsoft Windows
 24 | 
 25 | On Microsoft Windows you must install several dependencies:
 26 | 
 27 | 
 28 | ### BleachBit 3.x
 29 | 
 30 | *   [Python 2.7 32-bit](https://www.python.org/ftp/python/2.7.8/python-2.7.8.msi)
 31 | *   [PyGTK all-in-one installer](https://ftp.gnome.org/pub/GNOME/binaries/win32/pygtk/2.24/pygtk-all-in-one-2.24.2.win32-py2.7.msi)
 32 | *   [Python for Windows Extensions](https://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download)
 33 | 
 34 | Python, GTK+, and all Python extensions should be 32-bit. Mixing 64-bit and 32-bit components will cause errors.
 35 | 
 36 | Alternatively, use [gtk-download.sh](https://github.com/bleachbit/bleachbit-misc/blob/master/gtk-download.sh) and [gtk-unpack.sh](https://github.com/bleachbit/bleachbit-misc/blob/master/gtk-unpack.sh).
 37 | 
 38 | ### BleachBit 4.x
 39 | 
 40 | Follow the installation steps in [appveyor.yml](https://github.com/bleachbit/bleachbit/blob/master/appveyor.yml).
 41 | 
 42 | ## Getting the source code
 43 | 
 44 | To get the source code, either download the latest tarball (.tar.bz2) or checkout the Git source repository from Git, which always contains the latest code.
 45 | 
 46 | ### Tarball
 47 | 
 48 | On Linux unpack a tarball run these commands:
 49 | 
 50 | ```
 51 | tar xvjf bleachbit-3.2.0.tar.bz2
 52 | cd bleachbit-0.3.2.0
 53 | ```
 54 | 
 55 | On Windows unpack the tarball with [7-Zip](http://www.7-zip.org/) or similar application.
 56 | 
 57 | ### Git
 58 | 
 59 | On Linux, install the Git client. On Debian and Ubuntu install it with this command:
 60 | 
 61 | `sudo apt-get install git`
 62 | 
 63 | Similarly, on Fedora, Red Hat, and CentOS install the Git client with this command:
 64 | 
 65 | `sudo yum install git-core`
 66 | 
 67 | On Linux clone the Git repository for the BleachBit application with this command:
 68 | 
 69 | `git clone https://github.com/bleachbit/bleachbit.git`
 70 | 
 71 | Here is a full list of BleachBit Git repositories:
 72 | 
 73 | *   [BleachBit](https://github.com/bleachbit/bleachbit): main BleachBit application
 74 | *   [bleachbit-misc](https://github.com/bleachbit/bleachbit-misc): supports development
 75 | *   [CleanerML](https://github.com/bleachbit/cleanerml): extra cleaners
 76 | *   [winapp2.ini](https://github.com/bleachbit/winapp2.ini): winapp2.ini cleaners database for Windows
 77 | 
 78 | ### Building translations
 79 | 
 80 | If English is not your native language, you must build the translations. On Linux, run:
 81 | 
 82 | `make -C po local`
 83 | 
 84 | Building translations is not supported on Windows, but you can copy the translations from another system or download them from Launchpad. Relative to ```bleachbit.py``` put the ```bleachbit.mo``` file in a directory called ```.\locale\es\LC_MESSAGES\``` (change ```es``` according to the language.)
 85 | 
 86 | ### Running from source
 87 | 
 88 | Now that the dependencies are installed, you are ready to run BleachBit. On Linux with BleachBit 3.x, run `python bleachbit.py`. On Linux with BleachBit 4.x, run `python3 bleachbit.py`.
 89 | 
 90 | On Windows, double click on `bleachbit.py`.
 91 | 
 92 | ### Staying up to date with Git
 93 | 
 94 | The Git repository changes frequently. To download changes, run these commands:
 95 | 
 96 | ```
 97 | git pull
 98 | make -C po local
 99 | ```
100 | 
101 | ### Further reading
102 | 
103 | *   [Testing](/dev/testing.html)
104 | *   [Contributing patches and bug reports](https://www.bleachbit.org/contribute)
105 | 
106 | 
107 | 


--------------------------------------------------------------------------------
/css/syntax.css:
--------------------------------------------------------------------------------
 1 | .highlight .hll { background-color: #ffffcc }
 2 | .highlight  { background: #ffffff; }
 3 | .highlight .c { color: #888888 } /* Comment */
 4 | .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 5 | .highlight .k { color: #008800; font-weight: bold } /* Keyword */
 6 | .highlight .cm { color: #888888 } /* Comment.Multiline */
 7 | .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
 8 | .highlight .c1 { color: #888888 } /* Comment.Single */
 9 | .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
10 | .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
11 | .highlight .ge { font-style: italic } /* Generic.Emph */
12 | .highlight .gr { color: #aa0000 } /* Generic.Error */
13 | .highlight .gh { color: #333333 } /* Generic.Heading */
14 | .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
15 | .highlight .go { color: #888888 } /* Generic.Output */
16 | .highlight .gp { color: #555555 } /* Generic.Prompt */
17 | .highlight .gs { font-weight: bold } /* Generic.Strong */
18 | .highlight .gu { color: #666666 } /* Generic.Subheading */
19 | .highlight .gt { color: #aa0000 } /* Generic.Traceback */
20 | .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
21 | .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
22 | .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
23 | .highlight .kp { color: #008800 } /* Keyword.Pseudo */
24 | .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
25 | .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
26 | .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
27 | .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
28 | .highlight .na { color: #336699 } /* Name.Attribute */
29 | .highlight .nb { color: #003388 } /* Name.Builtin */
30 | .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
31 | .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
32 | .highlight .nd { color: #555555 } /* Name.Decorator */
33 | .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
34 | .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
35 | .highlight .nl { color: #336699; font-style: italic } /* Name.Label */
36 | .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
37 | .highlight .py { color: #336699; font-weight: bold } /* Name.Property */
38 | .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
39 | .highlight .nv { color: #336699 } /* Name.Variable */
40 | .highlight .ow { color: #008800 } /* Operator.Word */
41 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
42 | .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
43 | .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
44 | .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
45 | .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
46 | .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
47 | .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
48 | .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
49 | .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
50 | .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
51 | .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
52 | .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
53 | .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
54 | .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
55 | .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
56 | .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
57 | .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
58 | .highlight .vc { color: #336699 } /* Name.Variable.Class */
59 | .highlight .vg { color: #dd7700 } /* Name.Variable.Global */
60 | .highlight .vi { color: #3333bb } /* Name.Variable.Instance */
61 | .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
62 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang="en">
  3 |     <head>
  4 |         <meta charset="utf-8">
  5 |         <meta name="viewport" content="width=device-width">
  6 | 
  7 |         <title>{{ site.title }}{% if page.title %} : {{ page.title }}{% endif %}</title>
  8 |         <meta name="description" content="{{ site.subtitle }}">
  9 | 
 10 |         <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" rel="stylesheet">
 11 |         <link rel="stylesheet" href="{{ site.baseurl }}/css/syntax.css">
 12 |         <link rel="stylesheet" href="{{ site.baseurl }}/css/main.css">
 13 | 
 14 |         <link rel="canonical" href="https://docs.bleachbit.org{{ page.url | replace:'index.html','' }}">
 15 |     </head>
 16 |     <body>
 17 |         <div class="container">
 18 |             <div class="row">
 19 |                 <div id="header" class="col-sm-12">
 20 |                     {% include header.html %}
 21 |                 </div>
 22 |             </div>
 23 | 
 24 |             <div class="row">
 25 |                 {% assign post_count = site.posts|size %}
 26 |                 {% if site.navigation != 0 and site.navigation == 1 or post_count > 0 %}
 27 |                     <div id="navigation" class="col-sm-2">
 28 |                         {% include navigation.html %}
 29 |                     </div>
 30 | 
 31 |                     <div id="content" class="col-sm-10">
 32 |                         {{ content }}
 33 |                     </div>
 34 |                 {% else %}
 35 |                     <div id="content" class="col-sm-12">
 36 |                         {{ content }}
 37 |                     </div>
 38 |                 {% endif %}
 39 |             </div>
 40 | 
 41 |             {% if page.disqus == 1 %}
 42 |             <div class="row">
 43 |               {% if site.navigation == 1 or post_count > 0 %}
 44 |                 <div id="navigation" class="col-sm-2"></div>
 45 |                 <div id="disqus" class="col-sm-10">
 46 |                     {% include disqus.html %}
 47 |                 </div>
 48 |               {% else %}
 49 |                 <div id="disqus" class="col-sm-12">
 50 |                     {% include disqus.html %}
 51 |                 </div>
 52 |               {% endif %}
 53 |             </div>
 54 |             {% endif %}
 55 | 
 56 |             <div class="row">
 57 |                 <div id="footer" class="col-sm-12">
 58 |                     {% include footer.html %}
 59 |                 </div>
 60 |             </div>
 61 |         </div>
 62 | 
 63 |         <script>
 64 |             function orderNav() {
 65 |                 var list,
 66 |                     section,
 67 |                     header,
 68 |                     sections = [],
 69 |                     lists = {},
 70 |                     headers = {};
 71 | 
 72 |                 var navUl = document.querySelectorAll('#navigation ul')[0],
 73 |                     navLis = document.querySelectorAll('#navigation ul li');
 74 | 
 75 |                 if (!navUl) return;
 76 | 
 77 |                 for (var i = 0; i < navLis.length; i++) {
 78 |                     var order, li = navLis[i];
 79 | 
 80 |                     if (li.classList.contains('nav-header')) {
 81 |                         section = li.textContent || li.innerText;
 82 |                         sections.push(section);
 83 |                         headers[section] = li;
 84 |                         continue;
 85 |                     }
 86 | 
 87 |                     if (!lists[section]) {
 88 |                         lists[section] = [];
 89 |                     }
 90 | 
 91 |                     order = parseFloat(li.getAttribute('data-order'))
 92 |                     lists[section].push([order, li]);
 93 |                 }
 94 | 
 95 |                 for (var i = 0; i < sections.length; i++) {
 96 |                     section = sections[i];
 97 |                     list = lists[section].sort(function(a, b) {
 98 |                         return a[0] - b[0];
 99 |                     });
100 | 
101 |                     if (header = headers[section]) {
102 |                         navUl.appendChild(header);
103 |                     }
104 |                     for (var j = 0; j < list.length; j++) {
105 |                         navUl.appendChild(list[j][1]);
106 |                     }
107 |                 }
108 |             }
109 | 
110 |             if (document.querySelectorAll) orderNav();
111 |         </script>
112 |         {% if site.google_analytics_id != "" %}
113 |         {% include google_analytics.html %}
114 |         {% endif %}
115 |     </body>
116 | </html>
117 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-command-line-interface.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Command Line Interface"
  4 | category: doc
  5 | date: 2015-09-25 23:27:26
  6 | order: 4
  7 | ---
  8 | 
  9 | Most anything you can do with the graphical user interface, you can do with BleachBit's command line interface which serves two needs:
 10 | 
 11 | *   Automating cleaning in scripts, batch files, and scheduled tasks
 12 | *   Running BleachBit headless in terminal-only connections.
 13 | 
 14 | This page includes some examples.
 15 | 
 16 | ### Video
 17 | 
 18 | This video introduces the command line interface for Microsoft Windows.
 19 | 
 20 | <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Tdn81MXqcZo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 21 | 
 22 | ### Microsoft Windows
 23 | 
 24 | In Windows, use the executable `bleachbit_console.exe` to console output. The directory isn't added automatically to the path, so you use the full path `C:\Program Files (x86)\BleachBit\bleachbit_console.exe`. Where acceptable, it is best to substitute the environment variable `%ProgramFiles(x86)%` for `C:\Program Files (x86)\`.
 25 | 
 26 | ### Linux
 27 | 
 28 | Running `bleachbit` (which is in the path) with arguments runs BleachBit in command line mode. Without arguments, BleachBit runs in graphical mode. The clipboard can only be cleaned under an X session (which is generally not available over SSH or in cron).
 29 | 
 30 | ### Listing options
 31 | 
 32 | To see a list of cleaners and their options, run:
 33 | 
 34 | `bleachbit --list`
 35 | 
 36 | ### Preview
 37 | 
 38 | To preview deleting Firefox cache, run:
 39 | 
 40 | `bleachbit --preview firefox.cache`
 41 | 
 42 | Multiple arguments are allowed. To preview deleting Firefox cache and Opera cache, run:
 43 | 
 44 | `bleachbit --preview firefox.cache opera.cache`
 45 | 
 46 | Wildcards are allowed for options (though not cleaners), so to preview deleting all options for Opera, run:
 47 | 
 48 | `bleachbit --preview opera.*`
 49 | 
 50 | To select the same options as in the GUI, use ```--preset```, which may be combined with other options:
 51 | 
 52 | `bleachbit --preview --preset firefox.cookies`
 53 | 
 54 | 
 55 | ### Deleting files
 56 | 
 57 | When you are ready to delete files and make other permanent changes, replace ```--preview``` with ```--clean```. To vacuum Firefox, for example, run:
 58 | 
 59 | `bleachbit --clean firefox.vacuum`
 60 | 
 61 | ### Overwriting files
 62 | 
 63 | To overwrite the contents of files, so they cannot be undeleted later, add ```--overwrite```:
 64 | 
 65 | `bleachbit --overwrite --clean firefox.vacuum`
 66 | 
 67 | Without ```--overwrite```, BleachBit checks the configuration set in the graphical user interface.
 68 | 
 69 | ### Shredding files
 70 | 
 71 | To shred any file, so its contents cannot be recovered, use `--shred`. While `--overwrite` refers to the files identified by `--clean`, the option `--shred` shreds any file anywhere. For example, this shreds one file named `yoga_emails.txt`:
 72 | 
 73 | `bleachbit --shred ~/yoga_email.txt`
 74 | 
 75 | To shred all files under a directory, pass the name of the directory like this:
 76 | 
 77 | `bleachbit --shred "C:\Microsoft Exchange\Top Secret Emails\"`
 78 | 
 79 | 
 80 | ### Wiping free space
 81 | 
 82 | When files are [deleted without shredding](shred-files-and-wipe-disks.html), the contents might be recoverable from the disk's free space. To prevent recovery from free space, you can wipe the free space. Unlike wiping specific files, wiping free space takes a long time.
 83 | 
 84 | You might want to wipe free space for each logical drive. For example, on Windows you might wipe `C:` and `D:`, if you have both and write sensitive files to them both. On Linux, you might want to wipe `/` and `/home` if they are separate partitions and if you write sensitive information to both.
 85 | 
 86 | To wipe any partition, pass any writable directory in that partition to `--wipe-free-space`. For example:
 87 | 
 88 | `bleachbit --wipe-free-space ~/.cache/`
 89 | 
 90 | Wiping free space does not change how much free space is left, when the process is done. For example, if you start with 10GB free, then you will still have 10GB free when the process is done.
 91 | 
 92 | 
 93 | ### cron example (Linux)
 94 | 
 95 | To vacuum Firefox each night at 03:00, run:
 96 | 
 97 | `crontab -e`
 98 | 
 99 | and add this line:
100 | 
101 | `0 3 * * * bleachbit --clean firefox.vacuum`
102 | 
103 | ### Windows Task Scheduler
104 | 
105 | To vacuum Firefox each night at 03:00:
106 | 
107 | *   Open the Control Panel.
108 | *   Open Scheduled Tasks.
109 | *   Click **Add Scheduled Task**.
110 | *   Click **Next**.
111 | *   Click **Browse**.
112 | *   Choose ```C:\Program Files (x86)\BleachBit\bleachbit_console.exe```.
113 | *   Choose **Daily**.
114 | *   Set the start time.
115 | *   Click **Next**.
116 | *   Click **Next**.
117 | *   Check **Advanced Properties**.
118 | *   At the end of **Run**, add <tt>--clean firefox.vacuum</tt>.
119 | *   Click **OK**.
120 | 
121 | 
122 | 


--------------------------------------------------------------------------------
/_posts/2015-09-30-install-on-linux.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Install on Linux"
  4 | category: doc
  5 | date: 2015-09-30 20:37:20
  6 | order: 1
  7 | ---
  8 | 
  9 | 
 10 | To install BleachBit, first [download](https://www.bleachbit.org/download/linux) the latest installation package for your system.
 11 | 
 12 | ### Requirements
 13 | 
 14 | BleachBit version 2.2 required Python 2.7 and GTK version 2. It did *not* support Python 2.5, Python 2.7, Python 3, or GTK 3.
 15 | 
 16 | BleachBit 3 required GTK 3 and Python 2.7.
 17 | 
 18 | BleachBit 4 (the latest release) requires GTK 3 and Python 3. (It no longer supports Python 2.)
 19 | 
 20 | 
 21 | ### Ubuntu, Mint, and Debian
 22 | 
 23 | #### Graphical package manager
 24 | 
 25 | Double click on the downloaded installation package which has a name like `bleachbit_3.0_all_ubuntu1910.deb`. Then, follow the prompts.
 26 | 
 27 | #### Command line
 28 | 
 29 | Install using the command line like this:
 30 | 
 31 | `sudo dpkg -i bleachbit_3.0_all_ubuntu1910.deb`
 32 | 
 33 | Installing using apt from the distribution's repositories is _not_ recommended because they tend to carry old releases of BleachBit.
 34 | 
 35 | 
 36 | ### Fedora, Red Hat, CentOS
 37 | 
 38 | #### Graphical package manager
 39 | 
 40 | To install BleachBit using the graphic package manager, double click on the downloaded installation package which has a name like `bleachbit-3.0-1.1.fc28.noarch.rpm`. Then, follow the prompts.
 41 | 
 42 | The 3.0 package has a bug: it will not ask you to install the dependency `python2-gobject`, so you will need to install it yourself.
 43 | 
 44 | 
 45 | #### Command line
 46 | Alternatively, install using the command line like this.
 47 | 
 48 | First, install these dependencies for BleachBit 3.0. (BleachBit versions 2.x and 4.0 have different dependencies.)
 49 | 
 50 | `sudo dnf install python2-gobject python2-scandir`
 51 | 
 52 | To avoid a key error, import the public key:
 53 | 
 54 | ```
 55 | wget http://bleachbit.sourceforge.net/bleachbit_public.key -O /tmp/bleachbit_public.key
 56 | sudo rpm --import /tmp/bleachbit_public.key
 57 | ```
 58 | 
 59 | The following command installs BleachBit using the command line:
 60 | 
 61 | `sudo rpm -Uvh bleachbit-3.0-1.1.fc28.noarch.rpm`
 62 | 
 63 | ### Digital signatures
 64 | 
 65 | Verifying the digital signature protects you against file corruption and tampering.
 66 | 
 67 | To verify the digital signature, first you will need a public key. BleachBit versions 3.0 and later are signed with key 0xd6d447b02b4d4c9d ([gnupg.net](http://keys.gnupg.net/pks/lookup?search=0xD6D447B02B4D4C9D&fingerprint=on&op=index) or [SF](https://sourceforge.net/projects/bleachbit/files/public_key/andrew2019.key/download)). Older releases before BleachBit version 3.0 were signed with key 0x51416DE60E6887FD ([gpupg.net](http://keys.gnupg.net/pks/lookup?search=0x51416DE60E6887FD&fingerprint=on&op=index) or [SF](https://sourceforge.net/projects/bleachbit/files/public_key/andrew2009.key/download)). After downloading the key to a local file, import it into GnuPG like this:
 68 | 
 69 | ```
 70 | $ gpg --import andrew2019.key
 71 | gpg: key D6D447B02B4D4C9D: public key "Andrew Ziem <ahz001@gmail.com>" imported
 72 | gpg: Total number processed: 1
 73 | gpg:               imported: 1
 74 | ```
 75 | 
 76 | Notice the key ID D6D447B02B4D4C9D in the console output matches the key ID above on this web page. The key ID is case insensitive, and the leading `0x` is sometimes omitted, so the key IDs match.
 77 | 
 78 | Second, download either detached signatures or signed checksums. You do not need both.
 79 | 
 80 | There is one detached signature per download. Look in the [SourceForge release directory](https://sourceforge.net/projects/bleachbit/files/bleachbit/) for a folder called `detached_signatures`, and in the folder will be a file with the same name as the download plus the `.sig` extension. For example, the detached signature for `bleachbit_3.0_all_ubuntu1910.deb` is named `bleachbit_3.0_all_ubuntu1910.deb.sig`. Here is an example of how to verfy it.
 81 | 
 82 | ```
 83 | $ gpg --verify bleachbit_3.0_all_ubuntu1910.deb.sig bleachbit_3.0_all_ubuntu1910.deb
 84 | gpg: Signature made Sat 26 Oct 2019 08:04:00 AM MDT
 85 | gpg:                using RSA key A9E582E4054A159315EDC943D6D447B02B4D4C9D
 86 | gpg: Good signature from "Andrew Ziem <ahz001@gmail.com>" [ultimate]
 87 | ```
 88 | 
 89 | Instead of detached signatures, another option is the signed checksums. There is one signed checksum file per version of BleachBit. Verification is a two-step process. In the first step, verify the signature.
 90 | 
 91 | ```
 92 | $ gpg --verify bleachbit-3.0-sha256sum.txt.asc
 93 | gpg: Signature made Sat 26 Oct 2019 07:58:09 AM MDT
 94 | gpg:                using RSA key A9E582E4054A159315EDC943D6D447B02B4D4C9D
 95 | gpg: Good signature from "Andrew Ziem <ahz001@gmail.com>" [ultimate]
 96 | gpg: WARNING: not a detached signature; file 'bleachbit-3.0-sha256sum.txt' was NOT verified!
 97 | ```
 98 | Watch for the "Good signature," and ignore the warning.
 99 | 
100 | Second, verify the checksums like this:
101 | 
102 | ```
103 | $ sha256sum -c bleachbit-3.0-sha256sum.txt.asc
104 | bleachbit_3.0_all_debian10.deb: OK
105 | bleachbit_3.0_all_debian8.deb: OK
106 | bleachbit_3.0_all_debian9.deb: OK
107 | bleachbit_3.0_all_ubuntu1404.deb: OK
108 | bleachbit_3.0_all_ubuntu1604.deb: OK
109 | bleachbit_3.0_all_ubuntu1804.deb: OK
110 | bleachbit_3.0_all_ubuntu1810.deb: OK
111 | bleachbit_3.0_all_ubuntu1904.deb: OK
112 | bleachbit_3.0_all_ubuntu1910.deb: OK
113 | BleachBit-3.0-portable.zip: OK
114 | BleachBit-3.0-setup.zip: OK
115 | bleachbit-3.0-1.1.centos7.noarch.rpm: OK
116 | bleachbit-3.0-1.1.centosCentOS-6.noarch.rpm: OK
117 | bleachbit-3.0-1.1.el6.noarch.rpm: OK
118 | bleachbit-3.0-1.1.el7.noarch.rpm: OK
119 | bleachbit-3.0-1.1.fc28.noarch.rpm: OK
120 | bleachbit-3.0-1.1.opensuse423.noarch.rpm: OK
121 | bleachbit-3.0-1.1.sle11.noarch.rpm: OK
122 | BleachBit-3.0-setup-English.exe: OK
123 | BleachBit-3.0-setup.exe: OK
124 | bleachbit-3.0.tar.gz: OK
125 | bleachbit-3.0.tar.bz2: OK
126 | bleachbit-3.0.tar.lzma: OK
127 | sha256sum: WARNING: 17 lines are improperly formatted
128 | ```
129 | 
130 | If you don't download all the files, you will see "No such file or directory errors." Instead, focus on the "OK" for the file you downloaded. Also, ignore the "improperly formatted" warning because sha256sum doesn't recognize lines added by PGP.
131 | 
132 | 
133 | 
134 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-cleanerml.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Introduction"
  4 | category: cml
  5 | date: 2000-01-01 00:01:00
  6 | # The date is set to an old date to keep this article first in its section.
  7 | redirect_from:
  8 |  - doc/cleanerml
  9 | ---
 10 | 
 11 | **CleanerML** is a simple yet powerful markup language for writing cleaners. Most of BleachBit's cleaners are written in CleanerML, and you can write your own cleaners in CleanerML too.
 12 | 
 13 | You can think of it as writing XML to delete files, but it is more powerful than that. CleanerML's features include:
 14 | 
 15 | * Familiar XML
 16 | * Open standard
 17 | * Delete, truncate, or shred files
 18 | * Delete Windows registry keys and named values
 19 | * Perform specialized operations (see [Actions](#actions))
 20 | * Find files by glob, walking a tree, or 'deep scan'
 21 | * Refine a file search with a regular expression
 22 | * Export to gettext for translation using standard tools such as Launchpad
 23 | * Operating system detection to discard OS-specific cleaners (such as Winamp) at runtime
 24 | * XSD (XML Schema Definition) for validation
 25 | 
 26 | ### Storage
 27 | 
 28 | During application startup, BleachBit looks for CleanerML files in a few standard locations:
 29 | 
 30 | *   `/usr/share/bleachbit/cleaners/` on Linux
 31 | *   `~/.config/bleachbit/cleaners/` on Linux
 32 | *   `share/cleaners/` relative to the Python script on Linux (useful for running BleachBit from source without installation
 33 | *   `share\cleaners\` relative to the BleachBit executable on Windows which typically translates to ```c:\program files\bleachbit\share\cleaners```
 34 |     Warning: This directory is deleted when BleachBit is updated or uninstalled.
 35 | *   `%APPDATA%\BleachBit\cleaners\` on Windows which typically translates to `C:\Users\(username)\AppData\Roaming\BleachBit\Cleaners\`
 36 | 
 37 | Most of these locations are also scanned for [winapp2.ini](/doc/winapp2ini.html) files, but you may only use one winapp2.ini file.
 38 | 
 39 | The diagnostics section of the application lists these directories.
 40 | 
 41 | 
 42 | ### Learning CleanerML
 43 | 
 44 | To learn CleanerML so you can write your own cleaner, read these resources:
 45 | 
 46 | *   [Example cleaner](https://github.com/bleachbit/bleachbit/blob/master/doc/example_cleaner.xml) with many annotations
 47 | *   [Cleaners that come standard with BleachBit](https://github.com/bleachbit/bleachbit/tree/master/cleaners)
 48 | *   [Bonus cleaners](https://github.com/bleachbit/cleanerml)
 49 | *   [XSD (XML Schema Definition)](https://github.com/bleachbit/bleachbit/blob/master/doc/cleaner_markup_language.xsd) used for validation
 50 | 
 51 | ### Finding files to delete
 52 | 
 53 | 1.  Run the application you want to clean.
 54 |     * In the applications' preferences, turn on all logging (if applicable). For example, by default Pidgin turns off chat logs.
 55 |     * Use all the features of the application to try to make it generate as many files as it can. For example, in Nexuiz (a game) you must play a multiplayer game with a new map to cause the game to download the map into its cache. Many Nexuiz multiplayer games don't download maps.
 56 | 2.  Discover where the application stores its file. Assume your application is called Firefox: you could use the following commands to find its files.
 57 |     * Linux: `ls -d ~/.* | tail -n+3 | xargs -I '{}' find '{}' | grep -i firefox`
 58 |     * Windows: `dir /s /b $USERPROFILE | find /i "firefox"`
 59 | 3.  In some cases not all files appear using those commands. Perhaps the application checks for a file which doesn't often exist, or it writes a file but deletes it a moment later. In these cases use strace (for Linux) or [Process Monitor](https://docs.microsoft.com/en-us/sysinternals/downloads/procmon) (for Windows) to find these files. A standard invocation of strace (assuming you are launching Firefox) is: `strace -f -e trace=open,stat64,lstat64,access,mkdir,unlink,rename,readlink firefox &> /tmp/firefox.log grep -iE "(cache|log|tmp|$HOME)" /tmp/firefox.log | sort | uniq | less`
 60 | 4.  Search for registry entries in Windows: typically they are under ```HCKU\Software\(app name)```.
 61 | 5.  It's not strictly necessary, but it's nice if you put your cleaner in the ```cleaners``` directory of the BleachBit source and run ```make tests``` (to check it against the XSD) and ```make pretty``` (to reformat the XML).
 62 | 
 63 | ### Matching files
 64 | 
 65 | CleanerML allows several ways to match files:
 66 | 
 67 | *   **file**: matches a single file.
 68 | *   **glob**: matches one or more files with a simple pattern. See the Python documentation on [glob](https://docs.python.org/2/library/glob.html).
 69 | *   **walk.files**: matches all files under a directory (but does not match directories).
 70 | *   **walk.all**: matches all files and directories under a directory (but not the top directory).
 71 | *   **walk.top**: matches all contents of a directory and the top directory itself.
 72 | *   **deep**: queues a deep scan
 73 | 
 74 | What is the difference between a **deep** and **walk.files**? Deep scan expects file matches to be loosely scattered (such as Thumbs.db), but **walk.files** expects to match most files under that directory (such as Firefox's cache). To improve performance, BleachBit combines deep scans for the same directory (such as all deep scans for $HOME). In the future, BleachBit may allow the user to reconfigure the deep scan directory, so, for example, he can scan a network drive in addition to his home directory.
 75 | 
 76 | Any of these methods can be combined with [Python's Perl regular expressions](https://docs.python.org/2/howto/regex.html) for sophisticated filtering. The regular expression options are:
 77 | 
 78 | * **regex**: require the path, not including the directory, to match the expression
 79 | * **nregex**: require the path, not including the directory, to *not* match the expression
 80 | * **wholeregex**: require the full path to match the expression
 81 | * **nwholeregex**: require the full path to *not* match the expression
 82 | 
 83 | Another way to filter is using with **type**:
 84 | * **type="f"**: matches files
 85 | * **type="d"**: matches directories
 86 | * When unspecified, any kind of file system object will match
 87 | 
 88 | For more information, refer to the section [Learning](#learning-cleanerml).
 89 | 
 90 | ### Actions
 91 | 
 92 | The **action** element is a child of the **option** element.
 93 | 
 94 | Values for the **comand** attribute of the **action** element:
 95 | 
 96 | * **apt.autoclean**
 97 | * **apt.autoremove**
 98 | * **chrome.autofill**
 99 | * **chrome.databases_db**
100 | * **chrome.favicons**
101 | * **chrome.history**
102 | * **chrome.keywords**
103 | * **delete**: delete a file
104 | * **ini**: delete part of a .ini configuration file
105 | * **json**: delete part of a JSON file
106 | * **mozilla_url_history**
107 | * **office_registrymodifications**: clean the MRU for OpenOffice.org and LibreOffice
108 | * **process**: launch a process
109 | * **sqlite.vacuum**: vacuum an SQLite 3 database
110 | * **truncate**: truncate a file
111 | * **win.shell.change.notify**
112 | * **winreg**: delete a Windows registry key or value
113 | * **yum.clean_all**
114 | 
115 | Actions take an optional **os** attribute to limit the action to certain operating systems.
116 | 
117 | ### Operating system
118 | 
119 | The optional attribute **os** limits the scope of an element to certain operating systems.
120 | 
121 | Supported elements are
122 | 
123 | * **action**
124 | * **cleaner**
125 | * **running**
126 | * **value** under **var**
127 | 
128 | Valid values for *os* are:
129 | 
130 | * **bsd**
131 | * **darwin**
132 | * **linux**
133 | * **netbsd**
134 | * **openbsd**
135 | * **unix**: Darwin, Linux, or any BSD
136 | * **windows**
137 | 
138 | ### Running process
139 | 
140 | Set the *running* element to abort cleaning when an application is running. It accepts two attributes:
141 | 
142 | * **type**: required, either: **exe** for process name or **pathname** for a file on the file system
143 | * **os**: optional, any value for the operating system
144 | 
145 | ### Variables
146 | 
147 | BleachBit supports expansion of a variety of variables: tilde (home), environment variables, and
148 | multi-value variables. For more information, see [Variables](/cml/variables.html).
149 | 
150 | ### Sharing your cleaner
151 | 
152 | Of course, you may use your cleaner privately. If you wish to share it with others, see [Contribute Cleaner](/cml/contributing.html).
153 | 
154 | 
155 | 
156 | 


--------------------------------------------------------------------------------
/_posts/2021-04-17-testing.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Testing"
  4 | category: dev
  5 | date: 2021-04-17 17:30:57
  6 | ---
  7 | 
  8 | Interested in testing BleachBit to ensure high-quality releases? Follow this guide.
  9 | 
 10 | ## Skills
 11 | 
 12 | People with various levels of technical knowledge can help test BleachBit. Though not necessary, it helpful to know any of these skills: command line use, examining user profile directories, XML, and Python.
 13 | 
 14 | ## Coverage
 15 | 
 16 | Ideally all volunteer testers would always tests all parts of BleachBit on all platforms. Complete test coverage is unrealistic, so test at your own pace. Focus on testing the items noted for the latest beta, and then test as many items as possible on this page. If you don't test everything, focus on different tests rather than repeating tests you already completed.
 17 | 
 18 | ## Testing environment
 19 | 
 20 | Ideally you would be testing the [latest, bleeding-edge code from Git](/dev/running-from-source-code.html). Otherwise, test the latest [beta](https://www.bleachbit.org/category/blog-tags/beta) or [latest stable release](https://www.bleachbit.org/download).
 21 | 
 22 | Testing is needed on all supported platforms with latest versions of applications. In some cases it helps to test old versions of software (such as Google Chrome), so start with [FileHippo](http://www.filehippo.com) and [the Browser Archive](http://browsers.evolt.org/).
 23 | 
 24 | Test with popular antivirus/security software such as Norton, AVG, McAfee, Avast, and Bit Defender. (Sometimes antivirus software has [false positives which cause errors in BleachBit](http://bleachbit.sourceforge.net/forum/074-fails-errors).)
 25 | 
 26 | To avoid potentially damaging your system and to test additional platforms, consider testing in a virtual machine such as VirtualBox, but to maintain the authenticity of the test, you may want to copy your user profile (all the settings for all your software) from your real machine to the test machine. Also, use VirtualBox's snapshot feature to quickly roll back changes (to basically undelete any changes BleachBit made).
 27 | 
 28 | ## Installation
 29 | 
 30 | For Microsoft Windows:
 31 | 
 32 | *   If a previous installation is in place, the new installation will guide you through uninstalling it before you can install the new version.
 33 | *   Uninstalling will remove any shortcuts created by the installer in the start menu, desktop, quick launch menu, and startup folder.
 34 | 
 35 | ## Startup
 36 | 
 37 | These are some parts to test related to application startup.
 38 | 
 39 | ### Microsoft Windows
 40 | 
 41 | *   Starting BleachBit will immediately show the UAC prompt. Whether you accept or decline the UAC, BleachBit will start (with or without administrator privileges). When BleachBit starts, click Help - About - System Information and verify `IsUserAnAdmin` is False or True (depending whether you accepted or denied the UAC) .
 42 | *   Right click on the BleachBit shortcut and left click 'Run as Administrator.' When BleachBit starts, click Help - About - System Information and verify IsUserAnAdmin is True.
 43 | 
 44 | ### Linux
 45 | 
 46 | *   Start BleachBit with all these combinations: as a normal user, as root (logged in as root), with sudo, with gksu, with consolehelper, with the command line, and with the applications menu (GUI).
 47 | *   If running BleachBit with sudo, any new files and directories created in `~/.config/bleachbit` should be owned by the non-root user. To test this, rename or delete the configuration and run under sudo.
 48 | 
 49 | ## Localization
 50 | 
 51 | BleachBit is [translated to many languages](https://www.bleachbit.org/features/translations). Testing should include:
 52 | 
 53 | *   When starting, BleachBit automatically recognizes the preferred language set in the operating system. In Linux, this is set by the `LANG` environment variable. In Windows,open the Control Panel, click on Regionalization, choose your language under Standards and Formats.
 54 | *   Spelling and grammar are correct.
 55 | *   Phrases are translated in the correct context. For example, the single English word 'Delete' can be translated various ways to Italian depending whether it is in the menu or the BleachBit log, and it is not correct to use the same translation for both.
 56 | *   The translation is accurate: the meaning of words and phrases are the same as in English.
 57 | *   Words are used consistently. For example, in English the terms _directory_ and _folder_ mean the same thing.
 58 | *   Appearance is normal. For example, BleachBit 0.7.1 added line wrapping to the preferences dialog, so it wouldn't stretch too wide in some non-English languages.
 59 | *   In Linux, test an invalid local like this: `LANG=notreal bleachbit`
 60 | *   In Linux, test non-Unicode local like this: `LANG=en_US bleachbit` You may change `en_US` but do not add UTF-8 to the end. BleachBit 0.7.1 fixed a bug when the display was not Unicode and a filename had invalid encoding.
 61 | 
 62 | ## Preferences
 63 | 
 64 | ### Linux
 65 | The first time BleachBit is run, it should automatically select your language and English. Check in Preferences - Languages. To simulate running BleachBit for the first time, delete or rename ~/.config/bleachbit.
 66 | 
 67 | ## Delete
 68 | 
 69 | Clicking the delete button on the toolbar should always show a confirmation, and the default button on the confirmation dialog should be cancel.
 70 | 
 71 | ### General testing guidelines
 72 | 
 73 | After cleaning an application, run the application to make sure:
 74 | 
 75 | *   It still works correctly. For example, in BleachBit 0.6.0, cleaning Places in Firefox would cause Firefox not to save bookmarks.
 76 | *   No unannounced changes were made.
 77 | *   All the requested changes were made. For example, BleachBit 0.7.1 did not delete stored passwords for Firefox 3. See [CleanerML documentation](/documentation/cleanerml) for advanced instructions on finding more files to clean.
 78 | 
 79 | ### Google Chrome
 80 | 
 81 | Always test Google Chrome because it is one of the most-used cleaners. 
 82 | 
 83 | ### Special cleaners
 84 | 
 85 | Special cleaners perform operations more advanced than simply deleting files. These cleaners include:
 86 | 
 87 | *   Wipe free disk space
 88 | *   Wipe memory and swap (Linux)
 89 | *   Clear URL history in Firefox
 90 | *   Clear OpenOffice.org history
 91 | *   Delete broken .desktop files
 92 | *   APT
 93 | *   Yum
 94 | *   Clipboard
 95 | *   Vacuuming Firefox, Liferea, Yum
 96 | *   Empty Windows recycle bin
 97 | 
 98 | ### Mark for deletion
 99 | 
100 | On Windows, it's often necessary to mark a file for deletion because it is locked by a running process. Test this by cleaning the system temporary files and Internet Explorer.
101 | 
102 | ## Abort
103 | 
104 | During a long preview or a delete operation (such as localizations or free disk space), close the application window (the X in the corner). Then, verify the BleachBit process closes quickly (maximum of 5 seconds) using a tool such as top or Windows Task Manager.
105 | 
106 | ## Unit tests
107 | 
108 | If you are comfortable using the command line and are [prepared to run BleachBit from source code](/documentation/running-source-code), run the unit tests with this command:
109 | 
110 | `python3 tests/TestAll.py`
111 | 
112 | To run a special test case (such as General):
113 | 
114 | `python3 -m unittest tests.TestGeneral`
115 | 
116 | To run a specific test:
117 | 
118 | `python3 -m unittest tests.TestGeneral.GeneralTestCase.test_boolstr_to_bool`
119 | 
120 | Normally the unit tests skip over any permanent changes to your system, but if you want to enable destructive tests (which make changes _without_ any confirmation!) set the environment variable `DESTRUCTIVE_TEST=T`. **Use with caution!** Normally you would only enable destructive tests on a test machine such as a virtual machine. On Linux enable destructive tests like this:
121 | 
122 | `export DESTRUCTIVE_TESTS=T`
123 | 
124 | On Windows enable destructive tests with:
125 | 
126 | `set DESTRUCTIVE_TESTS=T`
127 | 
128 | To avoid changing your normal `bleachbit.ini` configuration file, set the environment variable `BLEACHBIT_TEST_OPTIONS_DIR` to an alternate directory. When the tests are called from `TestAll.py`, the environment variable is automatically set to a temporary directory.
129 | 
130 | 
131 | ## Release notes
132 | 
133 | [Release notes of beta versions](https://www.bleachbit.org/category/blog-tags/beta) contain instructions for testers on what to do and the expected results.
134 | 
135 | [Release notes of stable versions](https://www.bleachbit.org/category/blog-tags/release) list bugs that were fixed, and you can test whether they were thoroughly fixed and that there were no regressions. On recent releases, you will find links to lists of closed issues on GitHub where you can find more technical information.
136 | 
137 | ## Questions?
138 | 
139 | If you need help testing, [ask a question](https://www.bleachbit.org/help).
140 | 
141 | ## Filing new bugs
142 | 
143 | When you found a bug, report it to the [bug tracker](https://www.bleachbit.org/help). Follow the guidelines for filing good bug reports.
144 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-frequently-asked-questions.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Frequently Asked Questions"
  4 | category: doc
  5 | date: 2000-01-25 23:30:16
  6 | order: 5
  7 | ---
  8 | 
  9 | ### Question: Why do I see permissions denied errors on Linux?
 10 | 
 11 | Answer: If you are trying to clean the system (for example, localizations, APT, or DNF), run BleachBit with root permissions. To elevate permissions, choose the menu option "BleachBit as Administrator" _or_ run <tt>sudo</tt> on the command line.
 12 | 
 13 | Alternatively, when running as a normal user, uncheck options that require root permissions.
 14 | 
 15 | ### Q: Why do I see permission denied errors on Windows?
 16 | This happens when cleaning certain files, such as Windows system logs under ``c:\windows``.
 17 | A: When you first launch BleachBit it should prompt you with the User Access Control dialog, which asks, "Do you want to allow the following program to make changes to this computer." Answer *Yes* to grant BleachBit the privileges to modify all files. 
 18 | 
 19 | If you answer *No*, then BleachBit will start, and it will still be able to clean data under your user profile. However, it will not have access to clean system data.
 20 | 
 21 | ### Q: On Linux do I need to run BleachBit both as a normal user and as an administrator?
 22 | A: It depends how your system elevates privileges. Linux has various tools (for example, kdesudo, gksudo sudo, su-to-root, and PolicyKit) with various options to elevate to root (administrator) privileges, and they create two different situations.
 23 | 
 24 | In the first case, they switch the user to the root account, so BleachBit cleans the root account and not the non-privileged account. For example, BleachBit will clean root's web browsers, which are probably never used, so it may seem BleachBit is not finding the files you expect. In this case, use the Bleachbit as Administrator option to clean any system files that require special privileges, and then use regular BleachBit to clean files in your personal profile.
 25 | 
 26 | In the second case, BleachBit runs with elevated privileges in the context of the non-privileged account, so all options can cleaned from one session.
 27 | 
 28 | To check which case applies to you, start BleachBit as Administrator, click on Help - System Information, and look at the value for ```os.path.expanduser('~')```. If it equals ```/root```, then the first case is happening, so run BleachBit both as administrator and as a regular user to clean all files.
 29 | 
 30 | Another way to check is first to run BleachBit as administrator. Then run BleachBit as a regular user, and if the preview shows any files, then you may need to run BleachBit as a regular user.
 31 | 
 32 | ### Q: How to run the GUI as root on Linux under Wayland?
 33 | 
 34 | A: As the unprivileged user, run this command to allow the local user's X session:
 35 | 
 36 | ```xhost si:localuser:root```
 37 | 
 38 | When finished, disable the access:
 39 | 
 40 | ```xhost -si:localuser:root```
 41 | 
 42 | Avoid running GUI applications as root.
 43 | 
 44 | Source: [[ArchWiki]](https://wiki.archlinux.org/title/Running_GUI_applications_as_root)
 45 | 
 46 | ### Q: How do I recover a file deleted by BleachBit?
 47 | 
 48 | "I had BleachBit delete data, but now I want it back. Is there an undo command?"
 49 | 
 50 | A: The success of recovery depends on whether the file was overwritten, and the ease of recovery depends on whether the metadata was overwritten. If in the preferences the option "Overwrite files to prevent recovery" was enabled, the file probably cannot be recovered. There is an exception if the file system is ext3 or ext4 in `data=journal` mode. The default file system on Ubuntu is ext4 with `data=ordered` mode, which makes recovery unlikely.
 51 | 
 52 | If the *wipe free space* command was used on the same file system, the file probably cannot be deleted regardless of the type of file system. See also [Shred files and wipe disks](/doc/shred-files-and-wipe-disks.html) for more information.
 53 | 
 54 | The chances of recovery decline as data is written to the drive and as time passes.
 55 | 
 56 | Immediately the file is deleted in a normal way (in other words, if it is not overwritten), the full contents still exist and full recovery is stil possible. To maximize the chance of recovery, avoid writing any data to the file system. This step is most important when there is little free space. Often the file system for which recovery is desired is also the primary file system, so the computer should be turned off and rebooted into a bootable operating system from a bootable CD or USB drive.
 57 | 
 58 | Finally, run a file recovery tool. Do a search on the web for "undelete" or "file recovery."
 59 | 
 60 | ### Q: Why does BleachBit take a long time while filling up the hard drive?
 61 | 
 62 | A: You enabled the option to **System - Free disk space** to wipe free disk space for privacy. This works basically by creating a large, empty file (see [Shred files and wipe disks](/doc/shred-files-and-wipe-disks.html) for more information). The duration depends on the speed of the hardware and the free capacity, and it is common to take more than five minutes.
 63 | 
 64 | When the hard drive is full, BleachBit immediately deletes the file, and there will be no net change in disk space, so you will be back where you started. It is generally recommended you disable this option.
 65 | 
 66 | If this option is disabled, and BleachBit is slow, look at the option **Edit - Preferences - General - Overwrite Contents**. Enabling this option makes BleachBit slower because more work is required to make files unrecoverable.
 67 | 
 68 | ### Q: I closed BleachBit while it was working for a long time, and now my hard drive is full. How do I fix it?
 69 | A: Run BleachBit, and clean the option **System - Temporary Files**. On Linux, also clean **System - Cache**. This will delete one or more files that are gigantic and have random filenames.
 70 | 
 71 | In case you are using the command line or another application to delete these files, the default location on Linux is `~/.cache/`. If it is not the same partition, `/tmp/` is also used. On Windows, the default locations are `%TMP%`. If there are other fixed drives such as `D:`, they are also used.
 72 | 
 73 | If you changed the default options under **Preferences - Drives**, look there for the large files.
 74 | 
 75 | If you cannot boot Ubuntu because the disk is full, use the [Ubuntu Recovery Mode](https://wiki.ubuntu.com/RecoveryMode) like this:
 76 | 
 77 | 1. Reboot the system.
 78 | 1. Choose the boot option *Advanced options for Ubuntu*.
 79 | 1. Choose a recent kernel with *(recovery mode)*.
 80 | 1. In the Recovery Menu, choose _clean_. Note: this will mount your filesystem.
 81 | 1. If this cleans enough space, boot normally and then clean the cache as mentioned above.
 82 | 1. Otherwise, choose  _root_ from the Recovery Menu.
 83 | 1. Type this command to switch to your normal user account: <tt>su <i>username</i> -</tt>. (Replace _username_ with your username.)
 84 | 1. Run this command to clean the user's cache: 'rm -rf ~/.cache/`
 85 | 1. Reboot.
 86 | 
 87 | In the future, you may avoid this situation by disabling the BleachBit option **System - Free Disk Space**. Otherwise, do not interrupt BleachBit while it is working.
 88 | 
 89 | 
 90 | ### Q: How many passes does BleachBit make for the overwrite file option (shredding file)?
 91 | A: See [Shred files and wipe disks](/doc/shred-files-and-wipe-disks.html).
 92 | 
 93 | ### Q: How do I see BleachBit in my own language on Microsoft Windows?
 94 | A: There are a few ways to affect the language of the BleachBit user interface.
 95 | 
 96 | In the Windows search bar, type "Language settings" and open it. Under the Windows display language, choose the preferred language, and then restart BleachBit.
 97 | 
 98 | To force BleachBit to always show in English, you have a few options:
 99 | 
100 | * Download and install the English installer instead of the regular installer.
101 | * If using the regular (non-English-only) installer, uncheck the option to install translations.
102 | * Manually delete the translations. The default location for translations is `c:\Program Files (x86)\BleachBit\share\locale`.
103 | 
104 | The language chosen in the BleachBit installer does not affect the BleachBit application: it affects only the language of the installer.
105 | 
106 | Since [BleachBit 4.9.0 alpha](https://www.bleachbit.org/news/bleachbit-490-alpha), there is an option in the BleachBit preferences to change the language ([video demonstration](https://github.com/bleachbit/bleachbit/issues/1758#issuecomment-2603127349)). Most changes take effect immediately. To reflect changes for the application menu, restart the application.
107 | 
108 | ## Things to know
109 | 
110 | While these may not be asked, they are not common knowledge:
111 | 
112 | ### Q: What is format for the versioning number system?
113 | A: Since BleachBit version 1.0 the numbering system is like that of GNOME, Linux between 1.0 and 2.6, and other projects: the format is basically *a.b*. When *b* is odd like 1.1, it is an unstable release (alpha or beta), and when *b* is even like 1.2, it is a stable release. Also, *b* can be greater than 9, so version 1.10 is newer than version 1.8.
114 | 
115 | ### Q: Should I delete cache?
116 | A: Cache generally improves the performance of your computer. For example, browser cache prevents many files (such as pieces of web pages) from being downloaded again. Getting the file from the cache is much faster than downloading it&mdash;even with fast bandwidth. Applications (such as web browsers) normally delete the useless parts of cache to prevent it from growing too large and to make room for new, potentially-useful data.
117 | 
118 | Yet, cache contains content you have viewed and can be used to reconstruct some of your browsing history. Especially for applications that you deleted, some cache is never used, so the space is wasted. Finally, deleting a large cache saves time and storage space before making a backup.
119 | 
120 | ### Q: Should I delete cookies?
121 | A: Cookies are not inherently evil or dangerous. The following statements are *false*:
122 | 
123 | *   Cookies have no uses besides advertising
124 | *   Cookies can infect a computer like a virus
125 | *   Cookies cause popup ads
126 | *   Cookies can read arbitrary information from your computer (such as your name, your credit card, or private documents)
127 | 
128 | Cookies perform useful functions such as maintaining your login information: this saves you the time of logging in again. Many web sites use cookies to make honest improvements such as simplifying confusing navigation. Cookies rarely contain personally identifiable information (such as a name or email address). With a high degree of success (but a greater hassle for the web operator), web sites can still track visitors who have cookies disabled (using unique information such as IP address, user agent, plugins, etc), so disabling cookies may not have the intended effect.
129 | 
130 | On the other hand, some web sites use tricks (e.g., "evercookie" technology) to resurrect deleted cookies and try to track users between browsers on the same computer. Using another trick, cookies can track visitors between web sites for behavioural ad targeting: for example, once you visited an online camping store, and suddenly every other web site shows you ads for that camping store.
131 | 
132 | ### Q: Is BleachBit "safe"?
133 | A: BleachBit identifies and organizes the files you are most likely want to delete. For a few options which are most likely to cause you regret, it shows a popup warning. In that sense, BleachBit is much safer for a novice computer user than poking through the random directories hunting for files to delete. On the other hand, if the saying "One man's trash is another man's treasure" were not true or the saying "one size fits all" applied here, BleachBit would have no options. Carefully read the descriptions and warnings, and do not choose any options you do not understand or which make you uncomfortable.
134 | 
135 | ### Q: Will BleachBit make my computer faster?
136 | A: BleachBit probably will not make your computer faster in general, but there are two specific ways you may see your computer become faster. First, by removing excess files, you may see an improvement in the speed of virus scanning and for disk backups. Second, vacuuming SQLite databases speed up applications that use them. Firefox, Safari, and Google Chrome are some applications that stores various data, such as URL history, in an SQLite database. With heavy browsing, the databases become fragmented and bloated, and this happens at a level higher than the disk storage, so standard disk defragmentation tools are completely useless. BleachBit shrinks the SQLite database (saving disk space and disk I/O effort) and defragments them. You are most likely to see a dramatic benefit by not vacuuming for a while, using the application heavily, and then vacuuming it once, but to keep the application running quickly, vacuum often. Vacuuming is not a single solution to all performance problems, but it does complement other solutions. People buy faster computers with better CPUs and more RAM, but hard drive technology (other than the rare SSDs) has not become much faster than they were years ago. The hard disk is often the bottleneck, and vacuuming is one way to overcome this limitation.
137 | 
138 | Yet, deleting cache may make your computer slower because data will have to be re-downloaded or re-generated.
139 | 


--------------------------------------------------------------------------------
/_posts/2015-09-25-shred-files-and-wipe-disks.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: page
  3 | title: "Shred files and wipe disks"
  4 | category: doc
  5 | date: 2015-09-25 23:33:58
  6 | order: 6
  7 | ---
  8 | 
  9 | Normally when software deletes a file, only the "metadata" is erased: that means the complete contents often can easily be recovered, so BleachBit (and similar applications) offer secure erase features (also called secure wipe, secure overwriting, or file shredding) to permanently remove data. Some applications even advertise "advanced" erasure methods referencing important names in security such as Gutmann, the United States Department of Defense, and the NSA, but these references often mislead people to waste time on snake oil technological remedies while ignoring important basics. Any product or method suggesting a convenient, comprehensive solution to security is deceptive: convenience and security oppose each other. This guide will explain **how 1 pass is enough, but 35 passes are not enough.** Regardless of the tools you use, please read this guide carefully and completely.
 10 | 
 11 | 
 12 | ### Myths and legends
 13 | 
 14 | Most of the confusion regarding the topic of data remanence (data left behind after it is deleted) is because of myths and urban legends. Before discussing what is true, let's preview what is not:
 15 | 
 16 | *   False: Data on a hard drive overwritten by one pass can be recovered by powerful government agencies
 17 | *   False: Overwriting data with multiple passes makes it harder to recover than overwriting it with a single pass.
 18 | *   False: Peter Gutmann thinks data should be overwritten with 35 passes to prevent recovery.
 19 | *   False: Peter Gutmann's paper applies to modern hard drives.
 20 | *   False: There are methods approved by the DOD (5220.22-M), NSA, and Gutmann to shred files.
 21 | *   False: The United States Department of Defense approves of overwriting of a whole hard drive as a data sanitation method.
 22 | 
 23 | The details are explained below.
 24 | 
 25 | ### What features does BleachBit have to securely wipe files?
 26 | 
 27 | Today BleachBit offers these features
 28 | 
 29 | 1.  Overwrite specific files found by its cleaners to hide the contents of these files (such as Firefox Internet cache).
 30 | 2.  Overwrite specific files found anywhere on the hard drive (such as a confidential spreadsheet on your desktop).
 31 | 3.  Wipe free disk space to hide the contents of files previously deleted by any software.
 32 | 4.  Wipe memory and swap to wipe data stored in RAM such as passwords and web pages (currently, only on Linux).
 33 | 
 34 | Shredding is much slower than deleting because deleting changes only the file system metadata, which is small and a consistent size for all files: the metadata is the name of the file, its location on the disk, a time stamp, owner, etc. On the other hand, shredding takes time proportional to the size of the file.
 35 | 
 36 | Because additional passes add no value and only offer a false sense of security (see below), BleachBit does not implement multiple passes. When overwriting is enabled, BleachBit wipes the data with a single pass of blank data. At the end of a file, it may write additional data to wipe the slack space. To hide the original name, BleachBit renames the file to a long name and then a short name. Finally, the file is deleted.
 37 | 
 38 | Unlike other cleaner applications, BleachBit shreds Internet history in Firefox without deleting the whole Firefox Places database.
 39 | 
 40 | ### Are these features secure?
 41 | 
 42 | Concerned about the security of my house, once I asked a locksmith whether I should upgrade the standard lock on my front door. Not a good salesman, he replied, "Why bother? A burglar would just break the window."
 43 | 
 44 | Is driving a new car with air bags and a good crash test rating safe? Probably. How about when the car is operated by a 15-year old on a busy road at night while texting on his cell phone? Probably not. This analogy demonstrates two things. First, security is not black or white: there is always risk ranging from near (but not completely) zero to near 100%. Indeed, sometimes people even walk away from catastrophic car accidents. Second, the context is important: what is good in one situation is not good in another. Therefore, a better question is...
 45 | 
 46 | ### How secure are BleachBit's methods?
 47 | 
 48 | When used appropriately, BleachBit's data wiping features are generally enough to hide traces of most data from most people.
 49 | 
 50 | Even more important than asking how secure an application or technique is, start by asking yourself
 51 | 
 52 | 1.  What am I trying to hide? Is worth a lot of money? A few thousand that is in your bank account? A one million dollar trade secret?
 53 | 2.  How much harm could it do if disclosed? Embarrass someone? Hurt a relationship? Break compliance with HIIPA or SOX? Bankrupt a large company? Shift global political power?
 54 | 3.  Who would try to find it? A family member? A powerful rival company? A superpower government?
 55 | 4.  How much time, money, and skill does that entity have? How much is it willing to spend to find your secrets?
 56 | 
 57 | The answers to these questions will lead you to the appropriate level of caution.
 58 | 
 59 | ### Are multiple passes better than one pass?
 60 | 
 61 | Some applications offer "advanced" and "high security" erasure techniques such as Gutmann method (35 passes), Department of Defense (DOD) standard (7 passes), National Security Agency (NSA) "approved" (3 passes), etc. Introduced by a poor reading of Peter Gutmann's ancient paper, people incorrectly believe that overwriting the same data multiple times makes it more difficult to recover. Years after his original paper, Peter Gutmann himself tried to clear up the confusion caused by his original paper [[*](https://www.cs.auckland.ac.nz/~pgut001/pubs/secure_del.html#Epilogue)]:
 62 | 
 63 | > Some people have treated the 35-pass overwrite technique described in it more as a kind of voodoo incantation to banish evil spirit. [... ] In fact performing the full 35-pass overwrite is pointless for any drive since it targets a blend of scenarios involving all types of (normally-used) encoding technology.
 64 | 
 65 | Wikipedia explains further that a single pass is enough [[*](https://secure.wikimedia.org/wikipedia/en/wiki/Data_remanence#Feasibility_of_recovering_overwritten_data)]:
 66 | 
 67 | > The chances of overwritten data being recovered from a modern hard drive amount to "urban legend". He also points to the "18 1/2 minute gap" Rose Mary Woods created on a tape of Richard Nixon discussing the Watergate break-in. Erased information in the gap has not been recovered, and Feenberg claims doing so would be an easy task compared to recovery of a modern high density digital signal.
 68 | 
 69 | If recovery of data on modern media overwritten by a single pass were possible, scientists would publish papers about it, data recovery companies would charge top dollar for it, the use of it by government organizations would leak out in court cases, and drive manufactures would exploit it to increase storage capacity..
 70 | 
 71 | Second, shredding software which advertises these features often glosses over the application of the technique. **The DoD 5220.22-M standard was never intended be shred individual files or to wipe free disk space**: it was intended to wipe the entire hard drive causing a complete data loss including the operating system and all software, settings, and documents. Also, Department of Defense approves software shredding techniques only within the DoD: for storage devices released out of the Department of Defense, only mechanical destruction is approved. In other words, any software which shreds individual files or free disk space cannot be DOD or NSA compliant.
 72 | 
 73 | ### Limits of shredding files and wiping free disk space
 74 | 
 75 | Shredding individual files and free disk space has limited benefits for any cleaner application, including BleachBit. Once you understand the limits, you will know whether taking extra mitigation steps is worthwhile.
 76 | 
 77 | Shredding an individual file properly assumes its location can be completely known, but basically it can only be known in one ideal case. The ideal case has three characteristics:
 78 | 
 79 | 1.  The file size has never shrunk because of editing. Imagine starting with a 3MB spreadsheet, editing it down to 1MB (using the spreadsheet application), and asking the cleaner application to delete the 1MB version: the cleaner has no way of knowing where the missing 2MB was allocated on the physical hard drive. (Remember: file systems often don't store files continuously, so you can't assume the missing part was directly after the known part.) ![Graphic illustrating layout of file on disk in blocks](https://lh5.ggpht.com/_1XYQfEGGEIw/TMG_UyXYeVI/AAAAAAAACx4/mclA1xjpxlE/s800/file_shred_graphics.png)
 80 | 2.  The file never moved. Imagine the spreadsheet software saves the document by writing a new copy to a temporary file, deleting the old copy, and renaming the temporary file to the original name. In this case, the cleaner application has no way of knowing where any of the old spreadsheet was located.
 81 | 3.  The file system overwrites files to the same place. This is a good assumption. On Windows NTFS and on Linux the most common ext3 configuration (which is the default on Ubuntu 9.10 and other Linux distributions) overwrite files in the same place, but transparent disk compression, encryption, and sparse files may not overwrite files in place.
 82 | 
 83 | Though BleachBit cannot know the location of file after it is deleted or moved, neither can any other software. The deleted data is now floating in a giant pool of noise. In other words, a file shredded by BleachBit _even in these non-ideal scenarios_ is difficult to recover _partially_ and likely impossible to recover _fully_. A file shredding in the ideal case should be impossible to recover—even partially.
 84 | 
 85 | The three problems above are addressed by wiping free disk space: it doesn't matter where the previous file was located. If the deleted file is allocated now by a new file, the new file has overwritten it. If the previous location is not allocated now, the cleaner will overwrite it.
 86 | 
 87 | However, wiping free disk space has several of its own challenges:
 88 | 
 89 | 1.  It can be slow, so many people are not willing to use it.
 90 | 2.  File systems allocate space in fixed chunks called a block size, and many files do not use all the last block. A 5,000,000 byte file on a 4096 size block file system would use 1220 full blocks and 1 partial block with 2880 bytes. Say the file was deleted and a new file in the same place used 1024 bytes of the last block. That means 1856 bytes of the old file (0.03%) is not overwritten in what is called the "slack space" of the new file. Because cleaning slack space is tricky and realistically little useful data can be recovered from such tiny pieces (typically not more than 4096 bytes), BleachBit does not clean slack space when wiping free disk space. (Remember: BleachBit _does_ wipe slack when wiping individual files.)
 91 | 3.  When an area of a modern hard drive is damaged, it automatically remaps the bad sector to a spare. The operating system and applications are unaware of the move, so wiping the drive ignores the damaged area. According to [DBAN](https://dban.org/), a powerful disk wiping tool, it does not erase remapped sectors and hidden areas.
 92 | 
 93 | ### How to securely delete data
 94 | 
 95 | To permanently delete data, there is an order of progression with trade-offs of convenience and time vs privacy:
 96 | 
 97 | 1.  Shred the file (with one pass).
 98 | 2.  Overwrite the free disk space.
 99 | 3.  Overwrite the whole drive (including the operating system and all data).
100 | 4.  Mechanically destroy or degauss the drive.
101 | 5.  Destroy data on backups, ISPs, online accounts, etc.
102 | 
103 | However, in practice things become more complicated.
104 | 
105 | ### Keeping data private
106 | 
107 | Here are some suggestions to keep your data private
108 | 
109 | 1.  Don't keep secrets. It's easier to sleep.
110 | 2.  Don't waste time with multiple passes for data sanitation.
111 | 3.  Second guess any software which advertises multiple passes to wipe files or free disk space. Do the authors not honestly know what they are doing, or is a useless feature for marketing purposes?
112 | 4.  Use full volume encryption, though someone may [hit you with a $5 wrench](https://xkcd.com/538/) until you reveal the key.
113 | 5.  If giving a hard drive (or whole computer) to someone else, use DBAN to wipe the entire drive, including the remapped sectors—even though reinstalling an operating system, security updates, applications, and settings is a pain. It's not enough to delete files, empty the recycle bin (or trash can), and wipe the free space because some useful data may be in the swap file, hibernation file, Windows registry, and application registries (such as passwords in Firefox's configuration). If you are not willing to do that, minimally delete the user accounts on the system and _then_ wipe free disk space.
114 | 6.  If you need DoD class security, use the only sanitation method approved by the DoD 5220.22-M standard: degauss or mechanically destroy the storage device.
115 | 7.  Don't assume you control all the data. Say you download a file from www.example.com: there may be records on your computer, your ISP, www.example.com's server, www.example.com's ISP, www.example.com's backup site, the Internet backbone, etc. Think about how much data is stored on your email server, Facebook account, etc.
116 | 8.  Don't use any computers because the Nosy Secret Agents may looking over your shoulder using Van Eck phreaking.
117 | 
118 | ### Suggested reading
119 | 
120 | *   ["Data Remanence"](https://en.wikipedia.org/wiki/Data_remanence) (Wikipedia)
121 | *   ["Gutmann method: criticism"](https://en.wikipedia.org/wiki/Gutmann_method#Criticism) (Wikipedia)
122 | *   [One big file is not enough: A critical evaluation of the dominant free-space sanitization technique](https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.117.694&rep=rep1&type=pdf) (Garfinkel and Malan, 2006)
123 | 
124 | 
125 | 
126 | 
127 | 


--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------