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 # Command-line Options
  12
  13 The ClearClipboard program supports the following *mutually exclusive* command-line options:
  14
  15 * **`--close`**
  16   Close the running instance of ClearClipboard, if ClearClipboard is currently running. Does nothing, otherwise.
  17
  18 * **`--restart`**
  19   Start a new instance of ClearClipboard. If ClearClipboard is already running, the running instance is closed.
  20
  21 * **`--install`**
  22   Add "autorun" entry for ClearClipboard to the registry, so that ClearClipboard runs *automatically* at system startup.
  23
  24 * **`--uninstall`**
  25   Remove the "autorun" entry for ClearClipboard from the registry, if it currently exists. Does nothing, otherwise.
  26
  27 In addition, one or more of the following options may be appended to the command-line:
  28
  29 * **`--silent`**
  30   Suppress message boxes. Use, e.g., in combination with `--install` or `--uninstall` command.
  31
  32 * **`--debug`**
  33   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.
  34
  35 * **`--slunk`**
  36   Enable slunk mode for improved user experience. Check it out!
  37
  38
  39 # Configuration File
  40
  41 The behavior of the ClearClipboard program can be adjusted via a configuration file, in the [INI format](https://en.wikipedia.org/wiki/INI_file).
  42
  43 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.
  44
  45 The following configuration parameters are supported:
  46
  47 * **`Timeout=<msec>`**
  48   Specifies the timeout for automatic clipboard clearing, in milliseconds. Default: `30000`.
  49
  50 * **`Sound=<0|1|2>`**
  51   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`.
  52
  53 * **`Halted=<0|1>`**
  54   If this parameter is set to `1`, ClearClipboard starts in "halted" mode, i.e. with automatic clearing paused. Default: `0`.
  55
  56 ## Example Configuration
  57
  58 An example configuration file:
  59
  60         [ClearClipboard]
  61         Timeout=30000
  62         Sound=1
  63         Halted=0
  64
  65 # Version History
  66
  67 ## Version 1.03 [2019-05-30]
  68
  69 * Clipboard can be cleared manually by double-click on the shell notification icon or from the context menu.
  70
  71 * Optionally, a sound can be played whenever the clipboard is cleared.
  72
  73 * Automatic clipboard clearing can now be halted (suspended) or resumed at any time via the context menu.
  74
  75 * The additional configuration parameters `Sound` and `Halted` are supported now.
  76
  77 * Show message when "autorun" entry has been created or removed. Use option `--silent` to suppress.
  78
  79 * Some fixes and improvements.
  80
  81 ## Version 1.02 [2019-05-26]
  82
  83 * Added shell notification icon that can be used to control the ClearClipboard program.
  84
  85 * Some fixes and improvements.
  86
  87 ## Version 1.01 [2019-05-25]
  88
  89 * First public release.
  90
  91
  92 # License
  93
  94 **Copyright(&#9400;) 2019 LoRd_MuldeR &lt;mulder2@gmx.de&gt;, released under the MIT License.**
  95 **Check <http://muldersoft.com/> or <https://github.com/lordmulder/ClearClipboard> for updates!**
  96
  97         Permission is hereby granted, free of charge, to any person obtaining a copy of this software
  98         and associated documentation files (the "Software"), to deal in the Software without
  99         restriction, including without limitation the rights to use, copy, modify, merge, publish,
 100         distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 101         Software is furnished to do so, subject to the following conditions:
 102
 103         The above copyright notice and this permission notice shall be included in all copies or
 104         substantial portions of the Software.
 105
 106         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 107         BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 108         NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 109         DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 110         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 111
 112 <https://opensource.org/licenses/MIT>