Skip to content

Commit 8e810c4

Browse files
authored
Updated for command-line options.
1 parent f84882b commit 8e810c4

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,28 @@ Check the "Settings..." checkbox to reveal the settings; these should be relativ
2727

2828
To minimize Mouse Jiggler to the notification area, click the down-arrow button.
2929

30-
These settings are remembered from session to session. They can also be overridden by command-line options; for details, run `MouseJiggler -h`.
30+
These settings are remembered from session to session. They can also be overridden by command-line options:
31+
32+
```
33+
Usage:
34+
MouseJiggler [options]
35+
36+
Options:
37+
-j, --jiggle Start with jiggling enabled.
38+
-m, --minimized Start minimized (sets persistent option). [default: False]
39+
-z, --zen Start with zen (invisible) jiggling enabled (sets persistent option). [default: False]
40+
-s, --seconds <seconds> Set number of seconds for the jiggle interval (sets persistent option). [default: 1]
41+
--version Show version information
42+
-?, -h, --help Show help and usage information
43+
```
3144

3245
The `-j` command-line switch tells Mouse Jiggler to commence jiggling immediately on startup.
3346

47+
Bugs
48+
====
49+
50+
When installed using Chocolatey, command-line help may not be displayed properly. See "installation" above.
51+
3452
Features That Will Not Be Implemented
3553
=====================================
3654

0 commit comments

Comments
 (0)