cess
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
- x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd [-help] [-demo] [-activate] [-deacti-
- vate] [-lock] [-cycle] [-next] [-prev] [-exit] [-restart]
- [-version] [-time]
+ x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd [-help] [-demo] [-prefs] [-activate]
+ [-deactivate] [-cycle] [-next] [-prev] [-select _\bn] [-exit]
+ [-restart] [-lock] [-throttle] [-unthrottle] [-version]
+ [-time]
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
- The _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd program controls a running
+ The _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd program controls a running
_\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br process by sending it client-messages.
+ x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) has a client-server model: the xscreen-
+ saver process is a daemon that runs in the background; it
+ is controlled by other foreground programs such as
+ _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd and x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo(1).
+
+ This program, _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd, is a command-line-ori-
+ ented tool; the x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo(1). program is a graph-
+ ical tool.
+
O\bOP\bPT\bTI\bIO\bON\bNS\bS
- _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd accepts the following options:
+ _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd accepts the following command-line
+ options:
-\b-h\bhe\bel\blp\bp Prints a brief summary of command-line options.
- -\b-d\bde\bem\bmo\bo Cause the screensaver to enter its interactive
- demo mode, in which one can experiment with the
- various graphics hacks available. See x\bxs\bsc\bcr\bre\bee\ben\bn-\b-
- s\bsa\bav\bve\ber\br(1) for details.
+ -\b-d\bde\bem\bmo\bo This just launches the x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo(1) pro-
+ gram, in which one can experiment with the various
+ graphics hacks available, and edit parameters.
+
+ -\b-d\bde\bem\bmo\bo _\bn_\bu_\bm_\bb_\be_\br
+ When the _\b-_\bd_\be_\bm_\bo option is followed by an integer,
+ it instructs the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br daemon to run that
+ hack, and wait for the user to click the mouse
+ before deactivating (i.e., mouse motion does not
+ deactivate.) This is the mechanism by which
+ x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo(1) communicates with the
+ x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) daemon. (The first hack in the
+ list is numbered 1, not 0.)
+
+ -\b-p\bpr\bre\bef\bfs\bs Like the no-argument form of _\b-_\bd_\be_\bm_\bo, but brings up
+ that program's Preferences panel by default.
-\b-a\bac\bct\bti\biv\bva\bat\bte\be
- Tell the screensaver to turn on immediately (that
- is, pretend that the user been idle for long
- enough.) It will turn off as soon as there is any
- user activity, as usual.
+ Tell xscreensaver to turn on immediately (that is,
+ blank the screen, as if the user had been idle for
+ long enough.) The screensaver will deactivate as
+ soon as there is any user activity, as usual.
It is useful to run this from a menu; you may wish
- to run it as
- sleep 5 ; xscreensaver-command -activate
- to be sure that you have time to remove your hand
- from the mouse before the screensaver comes on.
- -\b-d\bde\bea\bac\bct\bti\biv\bva\bat\bte\be
- Tell the screensaver to turn off, as if there had
- been user activity. If locking is enabled, then
- the screensaver will prompt for a password as
- usual.
- -\b-l\blo\boc\bck\bk Like _\b-_\ba_\bc_\bt_\bi_\bv_\ba_\bt_\be, but a password will be required
- before the screensaver turns off, even if the
- screensaver's _\bl_\bo_\bc_\bk resource is false. The display
- will be locked immediately even if the screen-
- saver's _\bl_\bo_\bc_\bk_\bT_\bi_\bm_\be_\bo_\bu_\bt resource is non-zero.
+X Version 11 20-Jun-99 (3.15) 1
- -\b-c\bcy\byc\bcl\ble\be Tell the screensaver to change which graphics hack
- it is running, just as if the ``cycle'' timer had
- expired. A new hack will be chosen randomly.
- -\b-n\bne\bex\bxt\bt This is like either _\b-_\ba_\bc_\bt_\bi_\bv_\ba_\bt_\be or _\b-_\bc_\by_\bc_\bl_\be, depending
-X Version 11 31-May-97 1
+XScreenSaver(1) XScreenSaver(1)
+ to run it as
+ sleep 5 ; xscreensaver-command -activate
+ to be sure that you have time to take your hand
+ off the mouse before the screensaver comes on.
+ (Because if you jiggle the mouse, xscreensaver
+ will notice, and deactivate.)
-XScreenSaver(1) XScreenSaver(1)
+ -\b-d\bde\bea\bac\bct\bti\biv\bva\bat\bte\be
+ If the screensaver is active (the screen is
+ blanked), this command will deactivate it just as
+ if there had been keyboard or mouse activity. If
+ locking is enabled, then the screensaver will
+ prompt for a password as usual.
+ -\b-c\bcy\byc\bcl\ble\be If the screensaver is active (the screen is
+ blanked), then stop the current graphics demo and
+ run a new one (chosen randomly.)
- on which is more appropriate, except that the
- screenhack that will be run is the next one in the
- list of programs, instead of a randomly-chosen
- one. Repeatedly executing this will cycle through
- each hack in turn (though using the _\b-_\bd_\be_\bm_\bo option
+ -\b-n\bne\bex\bxt\bt This is like either _\b-_\ba_\bc_\bt_\bi_\bv_\ba_\bt_\be or _\b-_\bc_\by_\bc_\bl_\be, depending
+ on which is more appropriate, except that the
+ graphics hack that will be run is the next one in
+ the list, instead of a randomly-chosen one. In
+ other words, repeatedly executing -next will cause
+ the xscreensaver process to invoke each graphics
+ demo sequentially. (Though using the _\b-_\bd_\be_\bm_\bo option
is probably an easier way to accomplish that.)
-\b-p\bpr\bre\bev\bv This is like _\b-_\bn_\be_\bx_\bt, but cycles in the other direc-
tion.
- -\b-e\bex\bxi\bit\bt Causes the screensaver process to exit gracefully.
- This is a safer and easier way to kill the screen-
- saver than by using _\bk_\bi_\bl_\bl.
+ -\b-s\bse\bel\ble\bec\bct\bt _\bn_\bu_\bm_\bb_\be_\br
+ Like _\b-_\ba_\bc_\bt_\bi_\bv_\ba_\bt_\be, but runs the _\bNth element in the
+ list of hacks. By knowing what is in the _\bp_\br_\bo_\bg_\br_\ba_\bm_\bs
+ list, and in what order, you can use this to acti-
+ vate the screensaver with a particular graphics
+ demo. (The first element in the list is numbered
+ 1, not 0.)
+
+ -\b-e\bex\bxi\bit\bt Causes the xscreensaver process to exit grace-
+ fully. This is roughly the same as killing the
+ process with k\bki\bil\bll\bl(1), but it is easier, since you
+ don't need to first figure out the pid.
W\bWa\bar\brn\bni\bin\bng\bg:\b: never use _\bk_\bi_\bl_\bl _\b-_\b9 with _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br while
the screensaver is active. If you are using a
in an inconsistent state, and you may need to
restart your window manager to repair the damage.
- -\b-r\bre\bes\bst\bta\bar\brt\bt
- Causes the screensaver process to exit and then
- restart with the same command line arguments.
- This is a good way of causing the screensaver to
- re-read the resource database.
-
- If the screensaver is run from _\bx_\bd_\bm_\b(_\b1_\b) (that is, it
- is already running before you log in) then you may
- want to issue the ``restart'' command from one of
- your startup scripts, so that the screensaver gets
- your resource settings instead of the default
- ones.
-
- -\b-v\bve\ber\brs\bsi\bio\bon\bn
- Print (on stdout) the version number of the
- xscreensaver program that is running on $DISPLAY.
- (To see the version number of _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd
- itself, use the _\b-_\bh_\be_\bl_\bp option.)
-
- -\b-t\bti\bim\bme\be This option prints on stdout the time at which the
- screensaver last activated (blanked the screen) or
- deactivated (restored the screen.) Note that the
- activation-time is not the last time at which the
- user was active, but is some time later (it is the
- time at which either: xscreensaver decided that
- the user has been idle long enough; or, the user
- explicitly activated the screensaver or locker.)
+ -\b-l\blo\boc\bck\bk Tells the running xscreensaver process to lock the
+ screen immediately. This is like _\b-_\ba_\bc_\bt_\bi_\bv_\ba_\bt_\be, but
+ forces locking as well, even if locking is not the
-E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
- D\bDI\bIS\bSP\bPL\bLA\bAY\bY to get the host and display number of the screen
- whose saver is to be manipulated.
- P\bPA\bAT\bTH\bH to find the executable to restart (for the
- _\b-_\br_\be_\bs_\bt_\ba_\br_\bt command). Note that this variable is
+X Version 11 20-Jun-99 (3.15) 2
-X Version 11 31-May-97 2
+XScreenSaver(1) XScreenSaver(1)
-XScreenSaver(1) XScreenSaver(1)
+ default (that is, even if xscreensaver's _\bl_\bo_\bc_\bk
+ resource is false, and even if the _\bl_\bo_\bc_\bk_\bT_\bi_\bm_\be_\bo_\bu_\bt
+ resource is non-zero.)
+ Note that locking doesn't work unless the _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
+ _\bs_\ba_\bv_\be_\br process is running as you. See x\bxs\bsc\bcr\bre\bee\ben\bn-\b-
+ s\bsa\bav\bve\ber\br(1) for details.
- consulted in the environment of the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br
- process, not the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd process.
+ -\b-t\bth\bhr\bro\bot\btt\btl\ble\be
+ Temporarily switch to ``blank screen'' mode, and
+ don't run any display modes at all, until the
+ screensaver is next de-activated. This is useful
+ if you're using a machine remotely, and you find
+ that some display modes are using too much CPU.
-S\bSE\bEE\bE A\bAL\bLS\bSO\bO
- X\bX(1), x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1)
+ (If you want to do this _\bp_\be_\br_\bm_\ba_\bn_\be_\bn_\bt_\bl_\by, that is, you
+ want the screen saver to only blank the screen and
+ not run demos at all, then set the _\bp_\br_\bo_\bg_\br_\ba_\bm_\bs
+ resource to an empty list: See x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1)
+ for details.)
-B\bBU\bUG\bGS\bS
- Some diagnostics are reported on the stderr of the
- _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br process, not this process, so the caller of
- _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd may not see the error messages.
+ -\b-u\bun\bnt\bth\bhr\bro\bot\btt\btl\ble\be
+ Turn `-throttle' mode off and resume normal behav-
+ ior.
-C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
- Copyright (C) 1992, 1993, 1997 by Jamie Zawinski. Permis-
- sion to use, copy, modify, distribute, and sell this soft-
- ware and its documentation for any purpose is hereby
- granted without fee, provided that the above copyright
- notice appear in all copies and that both that copyright
- notice and this permission notice appear in supporting
- documentation. No representations are made about the
- suitability of this software for any purpose. It is pro-
- vided "as is" without express or implied warranty.
+ -\b-v\bve\ber\brs\bsi\bio\bon\bn
+ Prints the version of xscreensaver that is cur-
+ rently running on the display: that is, the actual
+ version number of the running xscreensaver back-
+ ground process, rather than the version number of
+ xscreensaver-command. (To see the version number
+ of _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd itself, use the _\b-_\bh_\be_\bl_\bp
+ option.)
+
+ -\b-t\bti\bim\bme\be Prints the time at which the screensaver last
+ activated or deactivated (roughly, how long the
+ user has been idle or non-idle: but not quite,
+ since it only tells you when the screen became
+ blanked or un-blanked.)
-A\bAU\bUT\bTH\bHO\bOR\bR
- Jamie Zawinski <jwz@netscape.com>, 13-aug-92.
+ -\b-r\bre\bes\bst\bta\bar\brt\bt
+ Causes the screensaver process to exit and then
+ restart with the same command line arguments as
+ last time. Do this after you've changed the
+ resource database, to cause xscreensaver to notice
+ the changes.
+ W\bWa\bar\brn\bni\bin\bng\bg:\b: if you have a _\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br file, this
+ might not do what you expect. You're probably
+ better off killing the existing xscreensaver (with
+ _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd _\b-_\be_\bx_\bi_\bt) and then launching it
+ again.
+ The important point is, you need to make sure that
+X Version 11 20-Jun-99 (3.15) 3
+XScreenSaver(1) XScreenSaver(1)
+ the xscreensaver process is running as you. If
+ it's not, it won't be reading the right _\b._\bx_\bs_\bc_\br_\be_\be_\bn_\b-
+ _\bs_\ba_\bv_\be_\br file.
+D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
+ If an error occurs while communicating with the _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
+ _\bs_\ba_\bv_\be_\br daemon, or if the daemon reports an error, a diag-
+ nostic message will be printed to stderr, and _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
+ _\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd will exit with a non-zero value. If the
+ command is accepted, an indication of this will be printed
+ to stdout, and the exit value will be zero.
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
+ D\bDI\bIS\bSP\bPL\bLA\bAY\bY to get the host and display number of the screen
+ whose saver is to be manipulated.
+ P\bPA\bAT\bTH\bH to find the executable to restart (for the
+ _\b-_\br_\be_\bs_\bt_\ba_\br_\bt command). Note that this variable is
+ consulted in the environment of the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br
+ process, not the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bc_\bo_\bm_\bm_\ba_\bn_\bd process.
+U\bUP\bPG\bGR\bRA\bAD\bDE\bES\bS
+ The latest version of x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) and related tools
+ can always be found at http://www.jwz.org/xscreensaver/
+S\bSE\bEE\bE A\bAL\bLS\bSO\bO
+ X\bX(1), x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo(1)
+C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
+ Copyright (C) 1992, 1993, 1997, 1998, 1999 by Jamie Zawin-
+ ski. Permission to use, copy, modify, distribute, and
+ sell this software and its documentation for any purpose
+ is hereby granted without fee, provided that the above
+ copyright notice appear in all copies and that both that
+ copyright notice and this permission notice appear in sup-
+ porting documentation. No representations are made about
+ the suitability of this software for any purpose. It is
+ provided "as is" without express or implied warranty.
+A\bAU\bUT\bTH\bHO\bOR\bR
+ Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
+ Please let me know if you find any bugs or make any
+ improvements.
-X Version 11 31-May-97 3
+X Version 11 20-Jun-99 (3.15) 4
projects / xscreensaver / blobdiff