README.md

   1 % ClearClipboard
   2 % Periodically ClearClipboard, e.g. to hide sensitive information
   3
   4 # Introduction
   5
   6 **ClearClipboard** is a simple tool that will *periodically clear* your clipboard. This is useful, for example, to hide sensitive information, such as passwords. The clear timeout can be configured freely and defaults to 30 seconds. Also, the clipboard will *not* simply be cleared at a fixed interval. Instead, the clear timer will be *reset* every time that new content is copied to the clipboard. This ensures that only "stale" content will be cleared; recently copied content will *never* be cleared away.
   7
   8 *Note:* The ClearClipboard program runs "hidden" in the background. However, there will be an icon in the [notification area](https://docs.microsoft.com/en-us/windows/desktop/uxguide/winenv-notification), which can be used to control or terminate ClearClipboard. Only one instance of ClearClipboard can be running at a time.
   9
  10
  11 # System requirements
  12
  13 ClearClipboard runs on Windows Vista or newer. The "x64" version requires a 64-Bit version of Windows Vista or newer.
  14
  15 Windows XP is **not** supported due to the lack of the `AddClipboardFormatListener` system function!
  16
  17 ## Windows 10 Warning
  18
  19 Windows 10 contains some "problematic" features that can put a risk on sensitive information copied to the clipboard:
  20
  21 * The first of those features is called "Clipboard History", which will silently keep a history (copy) of *all* data that has been copied to clipboard at some time. This history will persist even after the clipboard has been cleared!
  22
  23 * The second feature is called "Automatic Syncing" (Cloud Clipboard), which will automatically upload *all* data that is copied to clipboard to the Microsoft cloud servers – purportedly to synchronize the clipboard between your devices!
  24
  25 We ***highly*** recommend to *disable* both of these features in order to allow ClearClipboard to function as expected. You can easily do this in the "Windows Settings" on the "System/Clipboard" page. See [here](https://www.tenforums.com/tutorials/109799-turn-off-clipboard-history-windows-10-a.html) and [here](https://www.tenforums.com/tutorials/110048-enable-disable-clipboard-sync-across-devices-windows-10-a.html) for more information!
  26
  27
  28 # Command-line Options
  29
  30 The ClearClipboard program supports the following *mutually exclusive* command-line options:
  31
  32 * **`--close`**
  33   Close the running instance of ClearClipboard, if ClearClipboard is currently running. Does nothing, otherwise.
  34
  35 * **`--restart`**
  36   Start a new instance of ClearClipboard. If ClearClipboard is already running, the running instance is closed.
  37
  38 * **`--install`**
  39   Add "autorun" entry for ClearClipboard to the registry, so that ClearClipboard runs *automatically* at system startup.
  40
  41 * **`--uninstall`**
  42   Remove the "autorun" entry for ClearClipboard from the registry, if it currently exists. Does nothing, otherwise.
  43
  44 In addition, one or more of the following options may be appended to the command-line:
  45
  46 * **`--silent`**
  47   Suppress message boxes. Use, e.g., in combination with `--install` or `--uninstall` command.
  48
  49 * **`--debug`**
  50   Enable debug outputs (verbose mode). You can use the [DebugView](https://docs.microsoft.com/en-us/sysinternals/downloads/debugview) tool to show the generated debug messages.
  51
  52 * **`--slunk`**
  53   Enable slunk mode for improved user experience. Check it out!
  54
  55
  56 # Configuration File
  57
  58 The behavior of the ClearClipboard program can be adjusted via a configuration file, in the [INI format](https://en.wikipedia.org/wiki/INI_file).
  59
  60 The configuration file must be located in the same directory as the ClearClipboard executable. Also, it must have the same file name as the ClearClipboard executable, except that the file extension is replaced by **`.ini`**. The default configuration file name therefore is **`ClearClipboard.ini`**. All parameters need to be located in the **`[ClearClipboard]`** section.
  61
  62 The following configuration parameters are supported:
  63
  64 * **`Timeout=<msec>`**
  65   Specifies the timeout for automatic clipboard clearing, in milliseconds. Default: `30000`.
  66
  67 * **`Sound=<0|1|2>`**
  68   Controls sound effects. Mode `1` plays a sound, when the clipboard is cleared manually. Mode `2` additionally plays a sound every time that the clipboard is cleared automatically. And mode `0` disables all sounds. Default: `1`.
  69
  70 * **`Halted=<0|1>`**
  71   If this parameter is set to `1`, ClearClipboard starts in "halted" mode, i.e. with automatic clearing paused. Default: `0`.
  72
  73 * **`DisableWarningMessages=<0|1>`**
  74   If this parameter is set to `1`, ClearClipboard will *not* warn about "problematic" Windows 10 features. Default: `0`.
  75
  76 ## Example Configuration
  77
  78 An example configuration file:
  79
  80         [ClearClipboard]
  81         Timeout=30000
  82         Sound=1
  83         Halted=0
  84
  85 ## Sound File
  86
  87 ClearClipboard uses the "Empty Recycle Bin" system sound, as configured in the control panel (`control mmsys.cpl`). If that sound file is *not* found (or *not* configured), ClearClipboard will fall back to the "Asterisk" system sound.
  88
  89
  90 # Updates & Source Code
  91
  92 Please check the official web-site at **<http://muldersoft.com/>** or **<http://muldersoft.sourceforge.net/>** for updates!
  93
  94 The source code of ClearClipboard is available from our public Git repository, mirrored at:
  95 * `git clone https://github.com/lordmulder/ClearClipboard.git` ([Browse](https://github.com/lordmulder/ClearClipboard))
  96 * `git clone https://muldersoft@bitbucket.org/muldersoft/clearclipboard.git` ([Browse](https://bitbucket.org/muldersoft/clearclipboard/))
  97 * `git clone https://repo.or.cz/ClearClipboard.git` ([Browse](https://repo.or.cz/ClearClipboard.git))
  98
  99 # Version History
 100
 101 ## Version 1.03 [2019-05-31]
 102
 103 * Clipboard can be cleared *manually* by double-click on the shell notification icon or from the context menu.
 104
 105 * Optionally, a sound file can be played whenever the clipboard is cleared.
 106
 107 * Automatic clipboard clearing can now be halted (suspended) or resumed at any time via the context menu.
 108
 109 * The additional configuration parameters `Sound` and `Halted` are supported now.
 110
 111 * Show message when "autorun" entry has been created or removed. Use option `--silent` to suppress.
 112
 113 * Detection of "problematic" Windows 10 features (*Clipboard History* and *Cloud Clipboard Sync*)
 114
 115 * Added "x64" (64-Bit) binaries of the ClearClipboard program. Note: Requires 64-Bit Windows edition to run.
 116
 117 * Some fixes and improvements.
 118
 119 ## Version 1.02 [2019-05-26]
 120
 121 * Added shell notification icon that can be used to control the ClearClipboard program.
 122
 123 * Some fixes and improvements.
 124
 125 ## Version 1.01 [2019-05-25]
 126
 127 * First public release.
 128
 129
 130 # License
 131
 132 **Copyright(&#9400;) 2019 LoRd_MuldeR &lt;mulder2@gmx.de&gt;, released under the MIT License.**
 133
 134         Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 135         and associated documentation files (the "Software"), to deal in the Software without
 136         restriction, including without limitation the rights to use, copy, modify, merge, publish,
 137         distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 138         Software is furnished to do so, subject to the following conditions:
 139
 140         The above copyright notice and this permission notice shall be included in all copies or
 141         substantial portions of the Software.
 142
 143         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 144         BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 145         NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 146         DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 147         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 148
 149 <https://opensource.org/licenses/MIT>