Skip to content

Latest commit

 

History

History
178 lines (145 loc) · 10.7 KB

README.md

File metadata and controls

178 lines (145 loc) · 10.7 KB
Raw

Winapp2.ini

A database of extended cleaning routines for popular Windows PC based maintenance software.

Files of interest on this repo:

Name Purpose
Winapp2.ini An extended database of cleaning routines for CCleaner. This is the "main" file, and the one most users will want.
Winapp2ool A robust tool that allows you to manage Winapp2.ini for your system, including automatic downloading and trimming. This tool has its own ReadMe here.
non-CCleaner Winapp2.ini If you don't use CCleaner, this is the file you want. It includes entries that were removed from the main file due to having been included in CCleaner's official distribution. You should not use this file with CCleaner.
Winapp3.ini An extension for an extension; contains entries for use by power users. You should not use this file if you do not know what you are doing. Entries in this file can potentially be very aggressive/dangerous to your file system.

How to use Winapp2.ini for the following cleaners:

  • CCleaner:

    • Download the latest Winapp2.ini from this repo and place it in the same directory as ccleaner.exe.
    • Note: CCleaner 5.64.7577 is the last version to work on Windows XP and Vista (for non-SSE2 CPUs CCleaner 5.26.5937). Winapp2.ini and Winapp3.ini will continue to work with this version.

  • BleachBit:

    • Open BleachBit.
    • Select the "Edit" tab, and then "Preferences".
    • Check the box that reads "Download and update cleaners from community (Winapp2.ini)".
    • Note: BleachBit 2.2 is the last version to work on Windows XP. Winapp2.ini and Winapp3.ini will continue to work with this version.

  • System Ninja:

    • System Ninja ships with Winapp2.ini by default, storing it in your ..\System Ninja\scripts\ directory.
    • Note: System Ninja 3.2.7 is the last version to work on Windows XP and Vista. Winapp2.ini and Winapp3.ini will continue to work with this version.

  • Avira System Speedup:

    • Avira System Speedup ships with Winapp2.ini by default, storing it in your ..\Avira\System Speedup\sdf directory.

  • Tron:

    • Tron ships with Winapp2.ini by default, storing it in your ..\tron\resources\stage_1_tempclean\ccleaner directory.

  • R-Wipe & Clean:

Creating entries

Winapp2.ini entries are organized alphabetically, between sections in the file and individual key values in those sections. Alphabetically, numbers and symbols have precedence over letters. Entries should be ordered with their keys in the following precedence order.

[Entry Name *]

  • The name of the entry as it will appear to users.
  • Please include the space between the name and the * when submitting as this is how we visually indicate that Winapp2.ini entries are not a part of the host application running them.

DetectOS

  • This key is used to specify which operating systems the entry is for.
  • Not needed unless you want to limit your entry from running on specific versions of windows.
  • Kernel version numbering is used, here is a table for reference:
Kernel Number Windows Version
5.0 Windows 2000
5.1 Windows XP
5.2 Windows XP 64-Bit Edition, Windows Server 2003, Windows Home Server
6.0 Windows Vista, Windows Server 2008
6.1 Windows 7, Windows Server 2008 R2, Windows Home Server 2011
6.2 Windows 8, Windows Server 2012
6.3 Windows 8.1, Windows Server 2012 R2
10.0 Windows 10, Windows Server 2016, Windows Server 2019
  • To strictly limit an entry to a particular Windows version, use DetectOS=num|num:
    • DetectOS=5.1|5.1 will only run on WindowsXP.
  • To specify a minimum version number, use DetectOS=num|:
    • DetectOS=6.0| will only run on versions of Windows including and newer than Windows Vista.
  • To specify a maximum version number, use DetectOS=|num:
    • DetectOS=|6.1 will only run on versions of Windows including and older than Windows 7.
  • DetectOS criteria supersede all other detection criteria.
    • This means that entries with valid Detect or DetectFile keys will not be runnable if the system does not also pass the DetectOS check.

LangSecRef or Section

  • Defines the category of the entry.
  • If this key is not provided, CCleaner will append the entry to the bottom of the Applications tab.
  • Any value can be provided for Section keys.
  • If submitting an entry for a video game, please use Section=Games.
  • For LangSecRef, CCleaner syntax is followed. A table of valid values is below:
LangSecRef Section
3001 Internet Explorer
3005 Microsoft Edge
3006 Edge Chromium
3021 Applications
3022 Internet
3023 Multimedia
3024 Utilities
3025 Windows
3026 Firefox
3027 Opera
3028 Safari
3029 Google Chrome
3030 Thunderbird
3031 Windows Store
3032 CCleaner Browser
3033 Vivaldi
3034 Brave
3035 Opera GX
3036 Spotify
3037 Avast Secure Browser
3038 AVG Secure Browser

Detect or DetectFile

  • These keys specify the condition under which the key should be considered valid for a system.
  • If the target of these keys exists, the entry will be shown to the user. Otherwise it won't.
  • Detect keys point to Windows Registry paths.
  • DetectFile keys point to Windows Filesystem paths. Can point to either a directory or a specific file.
    • Wildcards are supported, but only in the last part of the parameterization.
    • Nesting wildcards in DetectFile is not supported by CCleaner.

Warning

  • This key is not required by any application.
  • Displays a warning to the user when they select an option.
    • Encouraged when running an entry may have unforeseen consequences for the user.
    • Only displayed when an option is selected (effectively once for most users), so it is wise to keep warnings short and concise, as users may read or fully understand them.

FileKey

  • Specifies a File System location(s) to be cleaned.
  • Supports wildcards and nesting.
  • You can specify multiple files to be cleaned at once by adding them as comments:
    • FileKey1=%SystemRoot%\junk|file1;file2 will delete both file1 and file2 from %SystemRoot%\junk.
  • The RECURSE flag will apply your cleaning parameters to all subdirectories of your given file system path:
    • FileKey1=%SystemRoot%\junk|junkfile*|RECURSE will delete any files whose name begin with junkfile from %SystemRoot%\junk and all of its subdirectories.
  • The REMOVESELF flag will do the same as RECURSE, but also remove any empty directories.

RegKey

  • Specifies a Windows Registry location to be cleaned.
  • Does not support wildcards of any sort.

ExcludeKey

  • Used to exclude a file, directory or registry path from cleaning, even if otherwise included in a FileKey or RegKey:
    • ExcludeKey1=FILE|%WinDir%\System32\LogFiles\|myfile.txt excludes myfile.txt in the %WinDir%\System32\LogFiles directory from being deleted.
    • ExcludeKey2=REG|HKCU\Software\Piriform will prevent keys in HKEY_CURRENT_USER\Software\Piriform from being deleted from the Registry.
  • Supports wildcards:
    • ExcludeKey1=PATH|C:\Windows\|*.exe excludes files of type .exe in the C:\Windows directory from being deleted.
    • ExcludeKey2=PATH|C:\Temp\|*.* excludes all of the files located in the C:\Temp directory and all sub directories from being deleted.
    • ExcludeKey3=PATH|%WinDir%\System32\LogFiles\SCM\|*-*-*-*.* excludes all of the files whose name matches the pattern *-*-*-*.* in the %WinDir%\System32\LogFiles\SCM directory from being deleted.

Unsupported functions:

The following are functions that are not used in the official Winapp2.ini file, but can still be used in a Custom.ini file.

Default

  • Allows you to set if you want an entry to be cleaned by default.
  • Default=True will clean an entry by default, while Default=False will not.
  • CCleaner assumes Default=False by default, while Avira System Speedup, BleachBit, System Ninja and Tron do not make use of this function.

SpecialDetect

  • Used for a quick way of detecting a path for a program.
  • More commonly, this was used for browser entries. For example, SpecialDetect=DET_CHROME would automatically find the default path for Chrome, so you do not need to make a Detect.
  • This function is not compatible when used alongside Detect or DetectFile and was since removed from Winapp2.ini due to compatibility issues.

Environment variables:

These are all the possible variables that can be used for writing paths in Winapp2.ini.

Variables marked with a * natively check both 64bit and 32bit locations on 64bit systems.
Variable Windows Vista-10 Path WindowsXP Path
%AppData% C:\Users\%UserName%\AppData\Roaming C:\Documents and Settings\%UserName%\Application Data
%CommonAppData% C:\ProgramData C:\Documents and Settings\All Users\Application Data
%CommonProgramFiles%* C:\Program Files\Common Files C:\Program Files\Common Files
%Documents% C:\Users\%UserName%\Documents C:\Documents and Settings\%UserName%\My Documents
%LocalAppData% C:\Users\%UserName%\AppData\Local C:\Documents and Settings\%UserName%\Local Settings\Application Data
%LocalLowAppData% C:\Users\%UserName%\AppData\LocalLow N/A
%Music% C:\Users\%UserName%\Music C:\Documents and Settings\%UserName%\My Documents\My Music
%Pictures% C:\Users\%UserName%\Pictures C:\Documents and Settings\%UserName%\My Documents\My Pictures
%ProgramFiles%* C:\Program Files C:\Program Files
%Public% C:\Users\Public N/A
%SystemDrive% C: C:
%UserProfile% C:\Users\%UserName% C:\Documents and Settings\%UserName%
%Video% C:\Users\%UserName%\Videos C:\Documents and Settings\%UserName%\My Documents\My Videos
%WinDir% C:\Windows C:\Windows

Custom.ini

Winapp2.ini does not support non-English system configurations or portable software natively. If you have need for these features, we recommend you utilize a "Custom.ini" file, and use Winapp2ool to merge it with the main file using the Add&Replace setting to override the existing entries.