1XLOCK(1) General Commands Manual XLOCK(1)
2
6 xlock - Locks the local X display until a password is entered.
7
10 xlock [ -help ] [ -version ] [ -resources ] [ -display displayname ] [
11 -visual visualname ] [ -name resourcename ] [ -mode modename ] [ -delay
12 usecs ] [ -batchcount num ] [ -count num ] [ -cycles num ] [ -ncolors
13 num ] [ -size num ] [ -saturation value ] [ -erasemode modename ] [
14 -erasedelay usecs ] [ -/+allowaccess ] [ -vtlock modename ] [ -/+nolock
15 ] [ -/+inwindow ] [ -/+inroot ] [ -/+remote ] [ -/+mono ] [ -/+allow‐
16 root ] [ -/+debug ] [ -/+description ] [ -/+echokeys ] [ -echokey
17 echokey ] [ -/+enablesaver ] [ -/+resetsaver ] [ -/+grabmouse ] [
18 -/+grabserver ] [ -/+install ] [ -/+mousemotion ] [ -/+sound ] [
19 -/+timeelapsed ] [ -/+usefirst ] [ -/+verbose ] [ -nice level ] [
20 -lockdelay seconds ] [ -timeout seconds ] [ -font fontname ] [ -plan‐
21 font fontname ] [ -bg color ] [ -fg color ] [ -background color ] [
22 -foreground color ] [ -username string ] [ -password string ] [ -info
23 string ] [ -validate string ] [ -invalid string ] [ -geometry geom ] [
24 -icongeometry geom ] [ -glgeometry geom ] [ -/+wireframe ] [ -/+showfps
25 ] [ -fpsfont fontname ] [ -/+fpstop ] [ -/+use3d ] [ -delta3d value ] [
26 -none3d color ] [ -right3d color ] [ -left3d color ] [ -both3d color ]
27 [ -program programname ] [ -messagesfile formatted-filename ] [ -mes‐
28 sagefile filename ] [ -message string ] [ -messagefont fontname ] [
29 -bitmap filename ] [ -cpasswd crypted-password ] [ -forceLogout minutes
30 ] [ -logoutButton minutes ] [ -logoutButtonLabel textstring ] [
31 -logoutButtonHelp textstring ] [ -logoutFailedString textstring ] [
32 -/+dtsaver ] [ -modulepath path ] [ -locksound string ] [ -infosound
33 string ] [ -validsound string ] [ -invalidsound string ] [ -startCmd
34 string ] [ -endCmd string ] [ -pipepassCmd string ] [ -logoutCmd string
35 ]
36
39 xlock locks the X server till the user enters their password at the
40 keyboard. While xlock is running, all new server connections are
41 refused. The screen saver is disabled. The mouse cursor is turned
42 off. The screen is blanked and a changing pattern is put on the
43 screen. If a key or a mouse button is pressed then the user is
44 prompted for the password of the user who started xlock.
45 If the correct password is typed, then the screen is unlocked and the X
47 server is restored. When typing the password Control-U and Control-H
48 are active as kill and erase respectively. To return to the locked
49 screen, click in the small icon version of the changing pattern.
50 In the lower part of the password screen a text is displayed. This
52 message is taken from the first file of the following that exists:
53 $HOME/.xlocktext, $HOME/.plan, or $HOME/.signature.
54 On systems which support new BSD style authentication, the password may
56 be prefixed by an authentication style followed by a colon (i.e.
57 "style:password"). See the login.conf(5) for more information on
58 authentication styles.
59
62 Xlock should not be used on public terminals when there is a high
63 demand for them.
64 If you find a public terminal that has been locked by another user and
66 there are no other terminals available, and the terminal appears to
67 have been left idle for a while (normally more than 15 minutes), it is
68 fair to try to reset the session in some manner.
69
72 -help
73 Print options and a brief description to standard output.
74 -version
76 Print version number (if >= 4.00) to standard output.
77 -resources
79 Print default resource file to standard output.
80 -display displayname
82 The display option sets the X11 display to lock. xlock locks all
83 available screens on a given server, and restricts you to locking
84 only a local server such as unix:0, localhost:0, or :0 unless you
85 set the -remote option.
86 -visual visualname
88 visualname which is one of "StaticGray", "GrayScale", "Static‐
89 Color", "PseudoColor", "TrueColor", "DirectColor", or "default".
90 default used to set the screen's default visual (the visual of the
91 root window).
92 -name resourcename
94 resourcename is used instead of XLock when looking for resources
95 to configure xlock.
96 -mode modename
98 As of this writing there are over 90 display modes supported (plus
99 one more for random selection of one of these). anemone Shows
100 wiggling tentacles.
101 apollonian
103 ant Shows Langton's and Turk's generalized ants.
105 ant3d Shows 3D ants.
107 apollonian
109 Shows Apollonian circles.
110 atlantis
112 Shows moving sharks/whales/dolphin. May not be available
113 depending on how it was configured.
114 atunnels
116 Advance GL tunnels screensaver. May not be available depending
117 on how it was configured.
118 ball Shows bouncing balls.
120 bat Shows bouncing flying bats.
122 biof Shows 3D bioform.
124 blot Shows Rorschach's ink blot test.
126 bouboule
128 Shows Mimi's bouboule of moving stars.
129 bounce Shows bouncing footballs.
131 braid Shows random braids and knots.
133 bubble Shows popping bubbles.
135 bubble3d
137 Shows Richard Jones's GL bubbles. May not be available depend‐
138 ing on how it was configured.
139 bug Shows Palmiter's bug evolution and a garden of Eden.
141 clock Shows Packard's oclock.
143 coral Shows a coral reef.
145 crystal Shows polygons in 2D plane groups.
147 daisy Shows a meadow of daisies.
149 dclock Shows a floating digital clock or message.
151 deco Shows art as ugly as sin.
153 demon Shows Griffeath's cellular automata.
155 dilemma Shows Lloyd's Prisoner's Dilemma simulation.
157 discrete
159 Shows various discrete maps.
160 dragon Shows Deventer's Hexagonal Dragons Maze.
162 drift Shows cosmic drifting flame fractals.
164 cage Shows the Impossible Cage, an Escher-like GL scene. May not be
166 available depending on how it was configured.
167 euler2d Shows a simulation of 2D incompressible inviscid fluid.
169 eyes Shows eyes following a bouncing grelb.
171 fadeplot
173 Shows a fading plot of sine squared.
174 fiberlamp
176 Shows a Fiber Optic Lamp.
177 fire Shows a 3D fire-like image. May not be available depending on
179 how it was configured.
180 flag Shows a waving flag image. This may be text or a graphic
182 image. Default text is the hostname and operating system.
183 flame Shows cosmic flame fractals.
185 flow Shows dynamic strange attractors.
187 forest Shows binary trees of a fractal forest.
189 fzort Shows a metallic-looking fzort.
191 galaxy Shows crashing spiral galaxies.
193 gears Shows GL's gears. May not be available depending on how it was
195 configured.
196 glplanet
198 Animates texture mapped sphere (planet)
199 goop Shows goop from a lava lamp.
201 grav Shows orbiting planets.
203 helix Shows string art.
205 hop Shows real plane iterated fractals.
207 hyper Shows spinning n-dimensional hypercubes.
209 ico Shows a bouncing polyhedron.
211 ifs Shows a modified iterated function system.
213 image Shows randomly appearing logos.
215 juggle Shows a Juggler, juggling.
217 julia Shows the Julia set.
219 kaleid Shows Brewster's Kaleidoscope.
221 kumppa Shows kumppa.
223 laser Shows spinning lasers.
225 life Shows Conway's game of life.
227 life1d Shows Wolfram's game of 1D life.
229 life3d Shows Bays' game of 3D life.
231 lightning
233 Shows Keith's fractal lightning bolts.
234 lisa Shows animated lissajous loops.
236 lissie Shows lissajous worms.
238 loop Shows Langton's self-producing loops.
240 mandelbrot
242 Shows mandelbrot sets.
243 marquee Shows text.
245 matrix Shows the matrix.
247 maze Shows a random maze and a depth first search solution.
249 moebius Shows the Moebius Strip II, an Escher-like GL scene with ants.
251 May not be available depending on how it was configured.
252 molecule
254 Draws molecules, based on coordinates from PDB (Protein Data
255 Base) files.
256 morph3d Shows GL morphing polyhedra. May not be available depending on
258 how it was configured.
259 mountain
261 Shows Papo's mountain range.
262 munch Shows munching squares.
264 noof Shows SGI Diatoms.
266 nose Shows a man with a big nose runs around spewing out text.
268 pacman Shows Pacman(tm).
270 penrose Shows Penrose's quasiperiodic tilings.
272 petal Shows various GCD Flowers.
274 petri Shows a mold simultation in a petri dish
276 pipes Shows a self-building pipe system. May not be available
278 depending on how it was configured.
279 polyominoes
281 Shows attempts to place polyominoes into a rectangle.
282 puzzle Shows a puzzle being scrambled and then solved.
284 pyro Shows fireworks.
286 qix Shows spinning lines a la Qix(tm).
288 roll Shows a rolling ball.
290 rotor Shows Tom's Roto-Rooter.
292 rubik Shows an auto-solving Rubik's Cube. May not be available
294 depending on how it was configured.
295 sballs Shows balls spinning like crazy in GL. May not be available
297 depending on how it was configured.
298 scooter Shows a journey through space tunnel and stars.
300 shape Shows stippled rectangles, ellipses, and triangles.
302 sierpinski
304 Shows a Sierpinski's triangle.
305 sierpinski3d
307 Shows a Sierpinski's gasket.
308 slip Shows slipping blits.
310 solitare
312 Shows Klondike's game of solitare.
313 space Shows a journey into deep space.
315 sphere Shows a bunch of shaded spheres.
317 spiral Shows a helical locus of points.
319 spline Shows colorful moving splines.
321 sproingies
323 Shows Sproingies! Nontoxic. Safe for pets and small children.
324 May not be available depending on how it was configured.
325 stairs Shows Infinite Stairs, an Escher-like GL scene. May not be
327 available depending on how it was configured.
328 star Shows a star field with a twist.
330 starfish
332 Shows starfish.
333 strange Shows strange attractors.
335 superquadrics
337 Shows 3D mathematical shapes. May not be available depending
338 on how it was configured.
339 swarm Shows a swarm of bees following a wasp.
341 swirl Shows animated swirling patterns.
343 t3d Shows a Flying Balls Clock Demo.
345 tetris Shows an autoplaying tetris game.
347 text3d | text3d2
349 Shows 3D moving texts.
350 thornbird
352 Shows an animated Bird in a Thorn Bush fractal map.
353 tik_tak Shows rotating polygons.
355 toneclock
357 Shows Peter Schat's toneclock.
358 triangle
360 Shows a triangular mountain range.
361 tube Shows an animated tube.
363 turtle Shows turtle fractals.
365 vines Shows fractal-like vines.
367 voters Shows Dewdney's Voters.
369 wator Shows Dewdney's Water-Torus planet of fish and sharks.
371 wire Shows a random circuit with 2 electrons.
373 world Shows spinning Earths.
375 worm Shows wiggly worms.
377 xjack Shows Jack having one of those days.
379 xcl Shows a Control Line combat model race
381 blank Shows nothing but a black screen. Does not show up in random
383 mode.
384 bomb Shows a bomb and will autologout after a time. Does not show
386 up in random mode and may be available depending on how it was
387 configured.
388 random Shows a random mode from above except blank (and bomb).
390 -delay usecs
393 The delay option sets the speed at which a mode will operate. It
394 simply sets the number of microseconds to delay between batches of
395 animations. In blank mode, it is important to set this to some
396 small number of seconds, because the keyboard and mouse are only
397 checked after each delay, so you cannot set the delay too high,
398 but a delay of zero would needlessly consume cpu checking for
399 mouse and keyboard input in a tight loop, since blank mode has no
400 work to do.
401 -count num
403 The batchcount option sets number of things to do per batch to num
404 .
405 In anenome mode it is means nothing.
407 In ant and ant3d modes this refers the number of ants.
409 In apollonian mode it is the number of possible ways to imbed cir‐
411 cles within a circle, all of integer curvature.
412 In atlantis mode it is the number of sharks.
414 In atunnels mode it is means nothing.
416 In ball mode it is the number of balls.
418 In bat mode it is the number of bats, could be less because of
420 conflicts.
421 In blot mode this refers to the number of pixels rendered in the
423 same color.
424 In bouboule mode it is the number of stars.
426 In bounce mode it is the number of balls, could be less because of
428 conflicts.
429 In braid mode it is the upper bound number of strands.
431 In bubble mode it is the number of bubbles.
433 In bubble3d mode it is the number of bubbles.
435 In bug mode it is the number of bugs, could be less because of
437 conflicts.
438 In cage mode it is means nothing.
440 In clock mode it is the percentage of the screen, but less than
442 100%.
443 In coral mode it is the number of seeds.
445 In crystal mode it is the number of polygons.
447 In daisy mode it is the number flowers that make a meadow.
449 In dclock mode it means nothing.
451 In deco mode it is the depth.
453 In demon mode this refers the number of colors.
455 In dilemma mode this refers the number of initial defectors.
457 In discrete mode it is the number of points.
459 In drift mode it is the number of levels to recurse (larger = more
461 complex).
462 In dragon mode it means nothing.
464 In euler2d mode it is the number of segments.
466 In eyes mode it is the number of eyes.
468 In fadeplot mode it is the number of steps.
470 In fiberlamp it is the number of fibers.
472 In fire mode it is the number of fire particles (set it to 0 to
474 have rain).
475 In flag mode it means nothing.
477 In flame mode it is the number of levels to recurse (larger = more
479 complex).
480 In flow mode it is the number of bees.
482 In forest mode it is the number trees that make a forest.
484 In fzort mode it means nothing.
486 In galaxy mode it means the number of galaxies.
488 In gears mode it is the number of degrees to rotate the set of
490 gears by.
491 In glplanet mode it is the number of hundredth degrees to roll the
493 planet by.
494 In goop mode it is the number of blobs per plane.
496 In grav mode it is the number of planets.
498 In helix mode it means nothing.
500 In hop mode this refers to the number of pixels rendered in the
502 same color.
503 In hyper mode it the number of dimensions.
505 In ico mode it is the ith platonic solid.
507 In ifs mode it means nothing.
509 In image mode it means it is the number of logos on screen at
511 once.
512 In juggle mode it is time in milliseconds between a throw and the
514 next catch.
515 In julia mode it is the depth of recursion.
517 In kaleid mode it is the number of pens.
519 In kumppa mode it means nothing.
521 In lament mode it means nothing.
523 In laser mode it is the number lasers.
525 In life and life3d modes it is the number of generations before a
527 glider is introduced.
528 In life1d mode it means nothing.
530 In lisa mode it is the number of loops.
532 In lissie mode it is the number of worms.
534 In loop mode it is the number of flaws.
536 In mandelbrot mode it is the order.
538 In marquee mode it means nothing.
540 In matrix mode it means nothing.
542 In maze mode it means nothing.
544 In moebius mode it is means nothing.
546 In molecule mode it means nothing.
548 In morph3d mode it is the ith platonic solid.
550 In mountain mode it is the number of mountains.
552 In munch mode it means nothing.
554 In noof mode it means nothing.
556 In nose mode it means nothing.
558 In qix mode it is the number of points.
560 In pacman mode it means the number of ghosts.
562 In penrose mode it means nothing.
564 In petal mode it the greatest random number of petals.
566 In petri mode it means nothing.
568 In pipes mode it shows different joints, 0 random, 1 spherical, 2
570 bolted elbow, 3 elbow, and 4 alternating.
571 In polyominoes mode it means nothing.
573 In puzzle mode it the number of moves.
575 In pyro mode it is the maximum number flying rockets at one time.
577 In roll mode it is the number of points.
579 In rotor mode it is the number of rotor thingys which whirr...
581 In rubik mode it is the number of moves.
583 In sballs mode it is the number of spheres.
585 In scooter mode it is the number of doors.
587 In shape mode it means nothing.
589 In sierpinski mode it is the number of points.
591 In slip mode it means nothing.
593 In solitare mode it means nothing.
595 In space mode it is the number of stars.
597 In sphere mode it means nothing.
599 In spiral mode it is the number of spirals.
601 In spline mode it is the number of points "splined".
603 In sproingies mode it is the number of sproingies.
605 In stairs mode it is means nothing.
607 In star mode it is the number of stars on the screen at once.
609 In starfish mode it means nothing.
611 In strange mode it means nothing.
613 In superquadrics mode its the number of horizontal and vertical
615 lines in the superquadric.
616 In swirl mode it means the number of "knots".
618 In swarm mode it is the number of bees.
620 In t3d mode it means nothing.
622 In tetris mode it means nothing.
624 In text3d mode it means nothing.
626 In thornbird mode it is the number of points.
628 In triangular mode it is the number of mountains.
630 In tube mode it is a rectangle (= 1), an ellipse (= 2), or a poly‐
632 gon if greater.
633 In turtle mode it means nothing.
635 In vines mode it is draw a complete vine (= 0) or a portion (= 1).
637 In voters mode it means the number of parties, 2 or 3.
639 In wator mode it means the breed time for the fish.
641 In wire mode it means the length of the circuit.
643 In world mode it is the number of worlds.
645 In worm mode it is the number of worms.
647 In xcl mode it represents the number of planes.
649 In xjack mode it means nothing.
651 In blank mode it means nothing.
653 In bomb mode it means the number of minutes to autologout.
655 A negative count allows for randomness. The range from the mini‐
657 mum allowed nonnegative count for a particular mode to the ABS(
658 count ) (or maximum allowed count , whichever is less).
659 -batchcount num
661 The batchcount option is deprecated but should still work as
662 count.
663 -cycles num
665 The cycles option sets the number of cycles until time out for
666 ant, ant3d, apollonian, blot, braid, bug, clock, crystal, daisy,
667 deco, demon, dilemma, discrete, dragon, eyes, fiberlamp, flag,
668 flow, forest, galaxy, helix, hop, hyper, ico, juggle, laser, life,
669 life1d, life3d, lisa, lissie, loop, mandelbrot, mountain, petal,
670 sierpinski, shape, spline +erase, t3d, thornbird, triangle, tube,
671 voters, wator, and wire. For euler2d and worm it is the length of
672 the lines, for atlantis it is the shark speed, for fadeplot, julia
673 and spiral it is the length of the trail of dots, munch it is the
674 minimum size of the squares, for kaleid it is the % of black, for
675 qix it is the number of lines, for spline -erase it means the num‐
676 ber of splines * 64 (for compatibility with +erase), for gears it
677 is the number of degrees to increment the spin of each gear by,
678 for glplanet it is the number of hundredth degrees to rotate the
679 planet by, for molecule it is the time in seconds until timeout,
680 for pipes it is the number of systems to draw before clearing the
681 screen, for rubik it is the number of steps to complete a 90 move,
682 for sballs it is the sphere speed value, for scooter it is the
683 speed, for superquadrics it is the number of frames it takes to
684 morph from one shape to another. for text3d it is the number of
685 times drawing a word before the next one, For others it means
686 nothing.
687 -size num
689 The size option sets the size maximum size of a star in bouboule,
690 pyro and star, size of ball in ball and bounce, size of bat in
691 bat, maximum size of bubble in bubble, size of clock in clock,
692 minimum size of rectangles in deco, size of the polygons in crys‐
693 tal, tik_tak, and toneclock, size of polyhedron in ico, size of
694 lissie in lissie, size of dots of flag, for kaleid it is the sym‐
695 metry, width of maze hallway, size of side of penrose tile, radius
696 of loop in lisa, radius of ball in roll, number of corners in
697 sierpinski, number of stars in scooter, size of tube in tube,
698 width of worm in worm, line width in rotor, size of cells in ant,
699 bug, dilemma, dragon, life, life1d, pacman, petri, tetris, voters,
700 wator, and wire. In pipes it is the maximum length of a system.
701 In flow and swarm it is the length of the lines. In atlantis it
702 is the shark size. A negative number allows for randomness, simi‐
703 lar to count. In atunnels, fire, gears, sballs and sproingies it
704 is the size of the screen (default 400), this is because on many
705 slow systems it runs too slow when the picture covers the full
706 screen. Set to 0 for full screen on fast machines.
707 -ncolors num
709 The ncolors option sets the maximum number of colors to be used.
710 -saturation value
712 The saturation option sets saturation of the color ramp used to
713 value . 0 is grayscale and 1 is very rich color. 0.4 is a nice
714 pastel.
715 -erasemode modename
717 As of this writing there are over 12 erase modes supported (if its
718 not chosen its assumed random). The erase modes are random_lines,
719 random_squares, venetian, triple_wipe, quad_wipe, circle_wipe,
720 three_circle_wipe, squaretate, fizzle, spiral, slide_lines,
721 losira, no_fade. modename is now similar to the option modelist
722 where you can it can be something like "all-losira" to get all
723 erasemodes but losira. Use a "+" or a "," to add modes like "spi‐
724 ral+venetian".
725 -erasedelay usecs
727 The erasedelay option sets the number of microseconds for steps of
728 the erasemode (a setting of 0 and the erasemode is bypassed).
729 +/-nolock
731 The nolock option causes xlock to only draw the patterns and not
732 lock the display. A key press or a mouse click will terminate the
733 screen saver.
734 -/+inwindow
736 Runs xlock in a window, so that you can iconify, move, or resize
737 it and still use your screen for other stuff. When running in a
738 window, xlock no longer locks your screen, it just looks good.
739 -/+inroot
741 Runs xlock in your root window. Like the inwindow option it no
742 longer locks the screen, it just looks good.
743 -/+remote
745 The remote option tells xlock to not stop you from locking remote
746 X11 servers. This option should be used with care and is intended
747 mainly to lock X11 terminals which cannot run xlock locally. If
748 you lock someone else's workstation, they will have to know your
749 password to unlock it. Using +remote overrides any resource
750 derived values for remote and prevents xlock from being used to
751 lock other X11 servers. (Use `+' instead of `-' to override
752 resources for other options that can take the `+' modifier simi‐
753 larly.)
754 -/+mono
756 The mono option causes xlock to display monochrome, (black and
757 white) pixels rather than the default colored ones on color dis‐
758 plays.
759 -/+allowaccess
761 This option is required for servers which do not allow clients to
762 modify the host access control list. It is also useful if you
763 need to run x clients on a server which is locked for some rea‐
764 son... When allowaccess is true, the X11 server is left open for
765 clients to attach and thus lowers the inherent security of this
766 lock screen. A side effect of using this option is that if xlock
767 is killed -KILL, the access control list is not lost.
768 -vtlock modename
770 This option is used on a XFree86 system to manage VT switching in
771 [off|noswitch|switch|restore] mode.
772 off means no VT switch locking.
774 switch means VT switch locking + switching to xlock VT when acti‐
776 vated.
777 restore means VT switch locking + switching to xlock VT when acti‐
779 vated + switching back to previous VT when desactivated.
780 noswitch means VT switch locking only when xlock VT is active.
782 -/+allowroot
784 The allowroot option allows the root password to unlock the server
785 as well as the user who started xlock. May not be able to turn
786 this on and off depending on your system and how xlock was config‐
787 ured.
788 -/+debug
790 Allows xlock to be debugged by doing all but locking the screen.
791 -/+description
793 The description option causes xlock shows a mode description above
794 password window. The default is to show this description.
795 -/+echokeys
797 The echokeys option causes xlock to echo '?' characters (default)
798 for each key typed into the password prompt. Some consider this a
799 security risk, so the default is to not echo anything.
800 -echokey echokey
802 The text character to use for echo key in echokeys .
803 -/+enablesaver
805 By default xlock will disable the normal X server's screen saver
806 since it is in effect a replacement for it. Since it is possible
807 to set delay parameters long enough to cause phosphor burn on some
808 displays, this option will turn back on the default screen saver
809 which is very careful to keep most of the screen black.
810 -/+resetsaver
812 By default xlock will call XResetScreenSaver. This may be unde‐
813 sirable with DPMS monitors.
814 -/+grabmouse
816 The grabmouse option causes xlock to grab the mouse and keyboard,
817 this is the default. xlock can not lock the screen without this.
818 -/+grabserver
820 The grabserver option causes xlock to grab the server. This is
821 not usually needed but some unsecure X servers can be defeated
822 without this.
823 -/+install
825 Allows xlock to install its own colormap if xlock runs out of col‐
826 ors. May not work on with some window managers (fvwm) and does
827 not work with the -inroot option.
828 -/+mousemotion
830 Allows you to turn on and off the sensitivity to the mouse to
831 bring up the password window.
832 -/+sound
834 Allows you to turn on and off sound if installed with the capabil‐
835 ity.
836 -/+timeelapsed
838 Allows you to find out how long a machine is locked so you can
839 complain to an administrator that someone is hogging a machine.
840 -/+usefirst
842 The usefirst option causes xlock to use the keystroke which got
843 you to the password screen as the first character in the password.
844 The default is to ignore the first key pressed.
845 -/+verbose
847 Verbose mode, tells what options it is going to use.
848 -nice nicelevel
850 The nice option sets system nicelevel of the xlock process to
851 nicelevel .
852 -lockdelay seconds
854 The lockdelay option sets the number of seconds before the screen
855 needs a password to be unlocked. Good for use with an autolocking
856 mechanism like xautolock(1).
857 -timeout seconds
859 The timeout option sets the number of seconds before the password
860 screen will time out.
861 -font fontname
863 The font option sets the font to be used on the prompt screen.
864 -planfont fontname
866 option sets the font to be used for the text that is displayed in
867 the lower part of the password screen.
868 -fg color
870 The fg option sets the color of the text on the password screen to
871 color .
872 -bg color
874 The bg option sets the color of the background on the password
875 screen to color .
876 -foreground color
878 The foreground option sets the color of the text on the password
879 screen to color .
880 -background color
882 The background option sets the color of the background on the
883 password screen to color .
884 -username string
886 Text string is shown in front of user name, defaults to "Name: ".
887 -password string
889 Text string is the password prompt string, defaults to "Password:
890 ".
891 -info string
893 Text string is an informational message to tell the user what to
894 do, defaults to "Enter password to unlock; select icon to lock.".
895 -validate string
897 Text string is a message shown while validating the password,
898 defaults to "Validating login..."
899 -invalid string
901 Text string is a message shown when password is invalid, defaults
902 to "Invalid login."
903 -geometry geom
905 The geometry option sets geom the size and offset of the lock win‐
906 dow (normally the entire screen). The entire screen format is
907 still used for entering the password. The purpose is to see the
908 screen even though it is locked. This should be used with caution
909 since many of the modes will fail if the windows are far from
910 square or are too small (size must be greater than 0x0). This
911 should also be used with -enablesaver to protect screen from phos‐
912 phor burn.
913 -icongeometry geom
915 The icongeometry option sets geom the size of the iconic screen
916 (normally 64x64) seen when entering the password. This should be
917 used with caution since many of the modes will fail if the windows
918 are far from square or are too small (size must be greater than
919 0x0). The greatest size is 256x256. There should be some limit
920 so users could see who has locked the screen. Position informa‐
921 tion of icon is ignored.
922 -glgeometry geom
924 The glgeometry option sets geom the size of the screen for gl
925 modes. Not normally available or needed.
926 -/+wireframe
928 Turn on/off wireframe, available on ant3d, atlantis, atunnels,
929 daisy, fire, gears, lament, life3d, mountain, sballs, sproingies,
930 superquadrics, and triangle.
931 -/+showfps
933 Turn on/off frame per sec display, available on atlantis, atun‐
934 nels, bubble3d, cage, fire, gears, invert, lament, moebius,
935 morph3d, rubik, sballs, stairs, and superquadrics.
936 -/+fpstop
938 Turn on/off frame per sec display on top of screen, used if
939 showfps is on.
940 -fpsfont fontname
942 The fpsfont option sets the font to be used in the frame per sec
943 display, used if showfps is on.
944 -/+use3d
946 Turn on/off 3d view, available on bouboule, pyro, star, and worm.
947 -delta3d value
949 Space between the center of your 2 eyes for 3d mode.
950 -none3d color
952 Color used for empty size in 3d mode.
953 -right3d color
955 Color used for right eye in 3d mode.
956 -left3d color
958 Color used for left eye in 3d mode.
959 -both3d color
961 Color used for overlapping images for left and right eye in 3d
962 mode.
963 -program programname
965 The program option sets the program to be used as the fortune gen‐
966 erator. Currently used only for marquee and nose modes.
967 -messagesfile formatted-filename
969 The messagesfile option sets the file to be used as the fortune
970 generator. The first entry is the number of fortunes, the next
971 line contains the first fortune. Fortunes begin with a "%%" on a
972 line by itself. Currently used only for marquee and nose modes.
973 If one exists, it takes precedence over the fortune program.
974 -messagefile filename
976 The messagefile option sets the file whose contents are displayed.
977 Currently used only for marquee and nose modes. If one exists, it
978 takes precedence over the fortune program and messagesfile.
979 -message textstring
981 The message option sets the text to be displayed in a mode. Cur‐
982 rently used only for flag, marquee and nose modes. If one exists,
983 it takes precedence over the fortune program, messagesfile and
984 message.
985 -messagefont fontname
987 The messagefont option sets the font to be used in the mode. Cur‐
988 rently used only for flag, marquee, and nose modes.
989 -bitmap filename
991 The bitmap option sets the xbm, xpm, or ras file to be displayed
992 with flag, image, life, life1d, maze, or puzzle mode. For eyes
993 and pacman only a xbm file is accepted. Certain modes reject the
994 bitmap if too big. /
995
998 -cpasswd crypted-password
999 The cpasswd option sets the key to be this text string to unlock
1000 xlock instead of password file.
1001 -forceLogout minutes
1003 The forceLogout option sets minutes to auto-logout.
1004 -logoutButton minutes
1006 The logoutButton option sets minutes to logoutButton is available
1007 on password screen.
1008 -logoutButtonLabel string
1010 Text string is a message shown inside logout button when logout
1011 button is displayed. Defaults to "Logout".
1012 -logoutButtonHelp string
1014 Text string is a message shown outside logout button when logout
1015 button is displayed. Defaults to "Click the \"Logout\" button to
1016 log out current\n user and make workstation available."
1017 -logoutFailedString string
1019 Text string is a message shown when a logout is attempted and
1020 fails. Defaults to "Logout attempt FAILED.\n Current user could
1021 not be automatically logged out."
1022 -/+dtsaver
1024 Turn on/off CDE Saver Mode. This option is only available if CDE
1025 support was compiled in.
1026 -modulepath path
1028 The modulepath option sets the directories that xlock searches for
1029 mode modules to load. It is a colon separated list of directories
1030 to search. If "%S" is included in the path, it is replaced by the
1031 default modulepath. To add a private module directory to the
1032 default path, use something like '%S:~/mymoduledir' as the path.
1033 This option is only available if module support was compiled in.
1034 -locksound string
1036 Text string references sound to use at lock time. Default sound,
1037 male voice: "Thank you, for your cooperation."
1038 -infosound string
1040 Text string references sound to use for information. Default
1041 sound, male voice: "Identify please."
1042 -validsound string
1044 Text string references sound to when a password is valid. Default
1045 sound, female voice: "Complete."
1046 -invalidsound string
1048 Text string references sound to when a password is invalid.
1049 Default sound, female voice: "I am not programmed to give you that
1050 information."
1051 -startCmd string
1053 Text string command to execute when the screen is locked. Commonly
1054 used instructions include: "zaway". This command, if still running
1055 when the screensaver exits, will be killed.
1056 -endCmd string
1058 Text string command to execute when the screen is unlocked.
1059 -pipepassCmd string
1061 Text string command into which to pipe the password when the
1062 screen is unlocked.
1063 -logoutCmd string
1065 Text string command to execute when the program logs the user out
1066 (either via the autologout or by pressing the logout button).
1067 -mailCmd string
1069 Text string command to execute when the program to check mail.
1070 -mailIcon string
1072 Text string of file for the "mail arrived" bitmap.
1073 -nomailIcon string
1075 Text string of file for the "no mail" bitmap.
1076 -dpmsstandby seconds
1078 Allows one to set DPMS Standby for monitor (0 is defined as infi‐
1079 nite). (Horizontal sync on, Vertical sync off, RGB guns off,
1080 power supply on, tube filaments energized, (screen saver mode).
1081 Typical 17 inch screen... 110 out of 120 watts with a 3 sec
1082 recovery time.) This option is only available if DPMS support was
1083 compiled in.
1084 -dpmssuspend seconds
1086 Allows one to set DPMS Suspend for monitor (0 is defined as infi‐
1087 nite). (Horizontal sync off, Vertical sync on, RGB guns off,
1088 power supply off, tube filaments energized. Typical 17 inch
1089 screen ... 15 out of 120 watts with a 3 sec recovery time.) This
1090 option is only available if DPMS support was compiled in.
1091 -dpmsoff seconds
1093 Allows one to set DPMS Power Off for monitor (0 is defined as
1094 infinite). (Horizontal sync off, Vertical sync off, Small auxil‐
1095 iary circuit stays on to monitor the HS/VS signals to enable power
1096 on when data needs to be displayed on the screen. Typical 17 inch
1097 screen ... 5 out of 120 watts with a 10 sec recovery time.) This
1098 option is only available if DPMS support was compiled in.
1099
1102 -neighbors num
1103 The neighbors option sets the number of neighbors of a cell to 3,
1104 4, 6, 9 (may not have real mathematical meaning), or 12 for sev‐
1105 eral automata modes (ant, bug, demon, dilemma, life, loop, voters,
1106 wator, and wire) (bug and loop do not span this full range). Set‐
1107 ting it to 0 typically randomizes this, except where bitmaps are
1108 used (dilemma, life, voters, and wator).
1109 -/+eyes
1111 Turn on and off eyes for ant, ant3d, and bug.
1112 -/+cycle
1114 Turn on and off colour cycling in crystal, lyapunov, mandelbrot,
1115 starfish, swirl, tetris, tik_tak, toneclock, and tube.
1116 -/+label
1118 Turn on and off alternate space and number labeling in apollonian.
1119 For ant and ant3d this turns on and off the labeling of the rule.
1120 For life and life3d this turns on and off the labeling of the pat‐
1121 tern name and rule.
1122 -/+serial
1124 Turn on and off sequential allocation of colors in kaleid. For
1125 life and life3d this turns on and off the picking of sequential
1126 patterns (to be used with middle button of the mouse).
1127 -/+trackmouse
1129 Turn on and off mouse interaction in eyes, fire, julia, solitare,
1130 sballs, swarm, and tetris. For maze, pacman, solitare and tetris
1131 this may not be available depending on how xlock was configured.
1132 -/+texture
1134 Turn on and off texturing in fire, lament and sballs. This may
1135 not be available depending on how xlock was configured.
1136 -rule <rule>
1138 The rule string is defined as S<neighborhood>/B<neighborhood> for
1139 life and life3d. Special parameters: P, picks a random rule from
1140 all rules that have known patterns; G, picks a random rule from
1141 all rules that have known gliders. For life a good example is
1142 Conway's rule which is S23/B3. Others are B36/S23 and
1143 B3678/S34678. For life3d good examples are Bay's rules which are
1144 S45/B5, S567/B6, S56/B5, and S67/B67. The rule string is defined
1145 as a binary string (requires at least one 1 and one 0) for ant and
1146 a base 4 (or quadranary) string (requires 3 of 4 digits to be rep‐
1147 resented) for ant3d. Here a special parameter, T and then a num‐
1148 ber, will pick a specific table.
1149 -lifefile filename
1151 The lifefile option sets the life and life3d lifeform. Only one
1152 format is currently supported, similar to the #P xlife format.
1153 For life3d, 2 linefeeds in a row are assumed to advance the depth.
1154 -arms num
1156 Allows one to set the number of arms in anemone.
1157 -finpoints num
1159 Allows one to set the width of the arms in anemone.
1160 -width num
1162 Allows one to set the final number of points in each array of
1163 anemone.
1164 -withdraws num
1166 Allows one to set the withdraw frequency in
1167 anemone.
1169 -turnspeed num Allows one to set the turning speed in
1170 -/+truchet
1172 Turn on and off Truchet lines (trail) in ant.
1173 -/+altgeom
1175 Turn on and off alternate geometries (off euclidean space, on
1176 includes spherical and hyperbolic) in apollonian mode.
1177 -whalespeed num
1179 Allows one to set the speed of the whales and dolphin in atlantis.
1180 -/+boil
1182 Turn on and off having the bubbles bubble up in bubble.
1183 -nx num
1185 Allows one to set the number of unit cells in x-direction in crys‐
1186 tal.
1187 -ny num
1189 Allows one to set the number of unit cells in y-direction in crys‐
1190 tal.
1191 -/+centre
1193 Turn on and off the centering on screen in crystal.
1194 -/+maxsize
1196 Turn on and off the centering on screen in crystal.
1197 -/+cell
1199 Turn on and off the drawing of unit cell in crystal.
1200 -/+grid
1202 Turn on and off the drwing of grid of unit cells (if -cell is on)
1203 in crystal.
1204 -/+garden
1206 Turn off and on garden look in daisy.
1207 -/+binary
1209 Turn on and off the binary clock in dclock.
1210 -/+led
1212 Turn on and off the led clock in dclock.
1213 -/+popex
1215 Turn on and off the population explosion counter in dclock.
1216 -/+forest
1218 Turn on and off the tropical deforest (hectares/acres) counter in
1219 dclock.
1220 -/+hiv
1222 Turn on and off the HIV infection counter in dclock.
1223 -/+lab
1225 Turn on and off the Animal Research counter in dclock.
1226 -/+veg
1228 Turn on and off the Animal Consumation counter in dclock.
1229 -/+y2k
1231 Turn on and off the Year 2000 countdown in dclock.
1232 -/+millennium
1234 Turn on and off the Second Millennium (January 1, 2001) countdown
1235 in dclock.
1236 -bonus value
1238 Allows one to set the bonus for cheating... between 1.0 and 4.0 in
1239 dilemma.
1240 -/+conscious
1242 Turn off and on self-awareness in dilemma.
1243 -/+grow
1245 Turn on and off growing fractals (else they are animated) for
1246 drift.
1247 -/+liss
1249 Turn on and off using lissajous figures to get points for drift.
1250 -/+fog
1252 Turn on and off fog for fire.
1253 -/+shadows
1255 Turn on and off shadows for fire.
1256 -trees num
1258 Validate the displaying of trees for fire if greater than zero.
1259 -/+invert
1261 Turn on and off inverting of the flag.
1262 -/+rotate
1264 Turn on/off rotating around attractor in flow.
1265 -/+ride
1267 Turn on/off rideing in the flow.
1268 -/+box
1270 Turn on/off bounding box in flow.
1271 -/+periodic
1273 Turn on/off periodic attractors in flow.
1274 -/+search
1276 Turn on/off search for new attractors in flow.
1277 -/+dbuf
1279 Turn on/off double buffering in flow.
1280 -/+tracks
1282 Turn on and off star tracks in galaxy.
1283 -/+light
1285 Turn on and off lighting of the planet for glplanet.
1286 -/+bounce
1288 Turn on and off bouncing movement of the planet for glplanet.
1289 -pimage filename
1291 Use the named xbm or xpm file for texturing the planet for
1292 glplanet. Use BUILTIN as filename for the builtin image taken
1293 from Xearth.
1294 -/+roll
1296 Turn on and off rolling of the planet for glplanet.
1297 -/+rotate
1299 Turn on and off rotation of the planet for glplanet.
1300 -/+texture
1302 Turn on and off texturing of the planet for glplanet.
1303 -/+stars
1305 Turn on and off showing stars in the background for glplanet.
1306 -/+decay
1308 Turn on and off decaying orbits for grav.
1309 -/+trail
1311 Turn on and off decaying trail of dots for grav.
1312 -/+ellipse
1314 Turn on and off ellipse format in helix.
1315 -/+martin
1317 Turn on and off Barry Martin's square root hop. -/+popcorn Turn
1318 on and off Clifford A. Pickover's popcorn hop.
1319 -/+ejk1...ejk6
1321 Turn on and off Ed J. Kubaitis' hops.
1322 -/+rr
1324 Turn on and off Renaldo Recuerdo's hop.
1325 -/+jong
1327 Turn on and off Jong's hop.
1328 -/+sine
1330 Turn on and off Barry Martin's sine hop.
1331 -pattern <pattern>
1333 Allows one to set the pattern for juggle.
1334 -tail num
1336 Minimum Trail Length for juggle.
1337 -/+real
1339 Turn on/off real-time juggling for juggle. Deprecated. There
1340 should be no need to turn off real-time juggling, even on slow
1341 systems. Adjust speed using -count.
1342 -/+describe
1344 Turn on/off pattern descriptions in juggle.
1345 -/+balls
1347 Turn on/off Balls in juggle.
1348 -/+clubs
1350 Turn on/off Clubs in juggle.
1351 -/+torches
1353 Turn on/off Flaming Torches in juggle.
1354 -/+knives
1356 Turn on/off Knives in juggle.
1357 -/+rings
1359 Turn on/off Rings in juggle.
1360 -/+bballs
1362 Turn on/off Bowling Balls in juggle.
1363 -/+planetary
1365 Turn on and off planetary gears in gears.
1366 -planetsize num
1368 Sets the size of the screen for planetary option in gears. This
1369 is for machines with slower CPU. (Set to 0 for full screen).
1370 -/+disconnected
1372 Turn on and off disconnected pen movement in kaleid.
1373 -/+alternate
1375 Turn on and off alternate rotated display mode kaleid.
1376 -/+quad
1378 Turn on and off quad mirrored/rotated mode similar to size 4 in
1379 kaleid.
1380 -/+oct
1382 Turn on and off oct mirrored/rotated mode similar to size 8 in
1383 kaleid.
1384 -/+linear
1386 Turn on and off Cartesian/Polar coordinate mode in kaleid.
1387 -/+conway
1389 Turn on and off John Conway's original Life rule S23/B3 life.
1390 -/+highlife
1392 Turn on and off David Bell's HighLife rule S23/B36 life.
1393 -/+daynight
1395 Turn on and off Nathan Thompson's Day and Night rule S34678/B3678
1396 life.
1397 -/+callahan
1399 Turn on and off Paul Callahan's S2b34/B2a hexagonal life.
1400 -/+andreen
1402 Turn on and off Bob Andreen's S2a2b4a/B2a3a4b hexagonal life.
1403 -/+trilife
1405 Turn on and off Carter Bays' S34/B45 triangular life.
1406 -/+trilife1
1408 Turn on and off Carter Bays' S45/B456 triangular life.
1409 -/+trilife2
1411 Turn on and off Carter Bays' S23/B45 triangular life.
1412 -/+totalistic
1414 Turn on and off totalistic rules for life1d. If this is off then
1415 it follows rules of the LCAU collection. These rules may not be
1416 symmetric and are more general.
1417 -/+additive
1419 Turn on and off additive functions mode in lisa.
1420 -/+dissolve
1422 Turn on and off disolving state in loop.
1423 -/+evolve
1425 Turn on and off Evolving Loops in loop.
1426 -/+langton
1428 Turn on and off Langton Loops for loop.
1429 -/+sheath
1431 Turn on and off sheath extension for loop.
1432 -/+wrap
1434 Turn on and off wrapping of borders for loop.
1435 -increment num
1437 Sets the option for increasing orders in mandelbrot.
1438 -/+alpha
1440 Turn on and off interior displaying level of closest return in
1441 mandelbrot.
1442 -/+binary
1444 Turn on and off binary decomposition color modulation in mandel‐
1445 brot.
1446 -/+dem
1448 Turn on and off Distance Estimator Method (instead of escape time)
1449 in mandelbrot.
1450 -/+index
1452 Turn on and off interior displaying iteration of closest return in
1453 mandelbrot.
1454 -/+lyap
1456 Turn on and off interior displaying according to an estimate of
1457 the Lyapunov exponent in mandelbrot.
1458 -/+pow
1460 Turn on and off adding z^z in mandelbrot.
1461 -/+sin
1463 Turn on and off adding sin(z) in mandelbrot.
1464 -/+noants
1466 Turn off and on ants in moebius.
1467 -/+solidmoebius
1469 Turn on and off solid Mobius strip in moebius.
1470 -/+atoms
1472 Turn on and off the drawing of spheres for the atoms in molecule.
1473 -/+bbox
1475 Turn on and off showing the molecules in a blue box in molecule.
1476 -/+bonds
1478 Turn on and off the drawing of the atomic bonds in molecule.
1479 -molecule filename
1481 Read a molecule structure from a pdb file in molecule.
1482 -/+labels
1484 Turn on and off the labeling of the atoms in molecule.
1485 -spin{x|y|z}
1487 Set the axis for molecule rotation in molecule. The default is
1488 "XYZ".
1489 +spin
1491 Turn off the molecule rotation in molecule.
1492 -/+titles
1494 Turn on and off the molecule description in molecule.
1495 -/+wander
1497 Turn on and off the moving of the molecule on a sinoid curve in
1498 molecule. Turn on and off movements in fire.
1499 -/+ammann
1501 Turn on and off lines for penrose.
1502 -increment value
1504 Allows fine adjustments to order in mandelbrot.
1505 -/+erase
1507 Turn on and off erasing for spline. If this option is on, cycles
1508 is divided by 64 to compute the number of lines, so as to be com‐
1509 patible when using -fullrandom.
1510 -factory num
1512 Number of extra factory parts in pipes.
1513 -/+fisheye
1515 Turn on if you want a zoomed-in view of pipes.
1516 -/+tightturns
1518 Turn on if you want the pipes to bend more often.
1519 -/+rotatepipes
1521 Turn on if you want the pipe system rotated in pipes.
1522 -/+complete
1524 Turn on or off complete graph morphing in qix.
1525 -size[xyz] num
1527 Number represents the number of cubies on the x, y, or z axis.
1528 Negative numbers offer randomness from 2 to the absolute value of
1529 the number. star.
1530 -/+hideshuffling
1532 Turn on or off hidden shuffle phase for rubik.
1533 -/+border
1535 Turn on or off borders in shape.
1536 -/+shadowing
1538 Turn on or off shadowing in shape.
1539 -/+stippling
1541 Turn on or off stippling in shape.
1542 -intensity value
1544 Set the brightness (default 2185) of the sierpinski structure for
1545 sierpinski3d.
1546 -maxdepth value
1548 Set the maximum depth (up to 10) of the sierpinski structure for
1549 sierpinski3d.
1550 -speed value
1552 Determines after how much steps the depth changes for sierpin‐
1553 ski3d.
1554 -trek num
1556 If its a high number you will see the space ship all the time in
1557 star.
1558 -/+rock
1560 Turn on and off rocks for star. If this is off, stars will be
1561 seen instead.
1562 -/+straight
1564 Turn on if star gets you motion sick.
1565 -cyclepeed num
1567 Set speed of cycling in starfish.
1568 -rotation num
1570 Set rotation velocity in starfish.
1571 -thickness num
1573 Set thickness in starfish.
1574 -/+rock
1576 Turn on and off blob for starfish.
1577 -spinspeed num
1579 Set speed of rotation, in degrees per frame for superquadrics.
1580 -/+bonus
1582 Turn on in tetris to see 5 square bonus pieces.
1583 -/+well
1585 Turn on in tetris to see welltris.
1586 -ttfont filename
1588 Sets the True Type font file (or font directory) used for text3d
1589 -extrusion num
1591 Sets length of the text extrusion for text3d
1592 -rot_amplitude float
1594 Sets rotation amplitude value of each letter for text3d
1595 -rot_frequency float
1597 Sets rotation frequency for text3d
1598 -/+no_split
1600 Turn on and off word splitting for text3d
1601 -ttanimate function_name
1603 Sets the animation function used for text3d. Currently one of :
1604 Random FullRandom Default Default2 None Crazy UpDown
1605 Extrude RotateXY RotateYZ Frequency Amplitude
1606 -speed km/h
1608 The speed for all planes in km/h for xcl.
1609 -frametime microseconds
1611 The time for one frame on the screen. This time is used to calcu‐
1612 late the delay time and depends on the speed of the X server for
1613 xcl.
1614 -line_length mm
1616 The distance between the pilot and the plane for xcl.
1617 -spectator mm
1619 The distance between spectator and pilot. It should be grater than
1620 the line_length and the half wing width of the plane to be not
1621 dangerous for the spectator for xcl.
1622 -viewmodel
1624 Shows an animated view of one model for xcl.
1625 -/+oldcolor
1627 Sets the colors for the first two planes fixed to red and yellow
1628 in xcl.
1629 -xcldebug
1631 Shows some additional timing information to make sure that the
1632 calibrate procedure goes right in xcl.
1633 -automatic
1635 The auto scale for automatic fit into the window is Deactivated
1636 with this option for xcl.
1637 -randomstart
1639 Use a random start point for models at startup for xcl.
1640 -preset num
1642 Use the preset num [1-5] for biof.
1643 -lines num
1645 Use num lines in biof.
1646 -points num
1648 Use num points in biof.
1649 -/+offangle
1651 Use offangle in biof.
1652 -duration seconds
1654 Allows one to set a duration for a mode in random. Duration of 0
1655 is defined as infinite.
1656 -/+fullrandom
1658 Turn on/off randomness options within modes in random. Not imple‐
1659 mented for all mode options.
1660 -modelist textstring
1662 Allows one to pass a list of files to randomly display to random.
1663 "all" will get all files but blank (and bomb if compiled in).
1664 "all,blank" will get all modes. "all,-image bounce,+blank" will
1665 get all modes excluding image and bounce modes. "bug wator" will
1666 get only bug and wator. "allgl" will get only the GL modes if
1667 compiled in, all-allgl will get all excluding the GL modes, "all‐
1668 nice" will weed out high cpu usage modes (as well as hackers and
1669 gl modes). "allxpm" will get all modes that use xpm. "allwrite"
1670 will get all modes that take advantage of writable colormaps (not
1671 including xpm). "all3d" will get all the modes that support this
1672 option. "allmouse" will get all the modes that support mouse
1673 interaction. Similarly, "allautomata" for automata modes, "all‐
1674 fractal" for fractal modes, "allgeometry" for geometry modes,
1675 "allspace" for space modes. The random mode itself can not be
1676 referenced.
1677 -/+sequential
1679 Turn on non-random random option.
1680
1683 xlock can appear to hang if it is competing with a high-priority
1684 process for the CPU. For example, if xlock is started after a process
1685 with 'nice -20' (high priority), xlock will take considerable amount
1686 of time to respond.
1687
1690 If the machine is using a shadow password system, then xlock may not be
1691 set up to get the real password and so must be given one of its own.
1692 This can be either on the command line, via the -cpasswd option, or in
1693 the file $HOME/.xlockrc, with the first taking precedence. In both
1694 cases an encrypted password is expected (see makekey(8)). If neither
1695 is given, then xlock will prompt for a password and will use that, also
1696 storing an encrypted version of it in $HOME/.xlockrc for future use.
1697
1700 If you use ssh-agent(1) to avoid entering a passphrase every time you
1701 use one of your ssh(1) private keys, it's good security practice to
1702 have ssh-agent forget the keys before you leave your terminal unat‐
1703 tended. That way, an attacker who takes over your terminal won't be
1704 able to use your private ssh keys to log in to other systems. Once you
1705 return to your terminal, you can enter the passphrase and re-add the
1706 keys to ssh-agent. There are a couple of ways in which xlock can help
1707 to automate this process. Firstly, the startCmd option allows xlock to
1708 be configured to run 'ssh-add -D' every time you lock the screen, so
1709 that your keys are automatically deleted from ssh-agent. If the
1710 passphrase on your ssh keys is the same as your password, then xlock
1711 can also be made to re-add the keys to ssh-agent when you unlock the
1712 screen, via the pipepassCmd option. This requires a bit of scripting,
1713 as the command must read your password from standard input and then
1714 automate the interaction with ssh-add to re-add the keys. There is an
1715 example of such a script in the xlock distribution - see etc/xlockssh*
1716
1719 "kill -KILL xlock " causes the server that was locked to be unusable,
1720 since all hosts (including localhost) were removed from the access con‐
1721 trol list to lock out new X clients, and since xlock could not catch
1722 SIGKILL, it terminated before restoring the access control list. This
1723 will leave the X server in a state where "you can no longer connect to
1724 that server, and this operation cannot be reversed unless you reset the
1725 server." -From the X11R4 Xlib Documentation, Chapter 7.
1726 NCD terminals do not allow xlock to remove all the hosts from the
1727 access control list. Therefore you will need to use the "-remote" and
1728 "-allowaccess" switches. If you happen to run without "-allowaccess"
1729 on an NCD terminal, xlock will not work and you will need to reboot the
1730 terminal, or simply go into the SETUP menus, under 'Network Parame‐
1731 ters', and turn off TCP/IP access control.
1732
1734 X(1), Xlib Documentation.
1735
1738 Maintained by:
1739 David Albert Bagley, <bagleyd@tux.org>
1740 The latest version is currently at:
1742 ftp://ftp.tux.org/pub/tux/bagleyd/xlockmore
1743 ftp://ftp.x.org/contrib/applications
1744 Original Author:
1746 Patrick J. Naughton, <naughton@eng.sun.com>
1747 Mailstop 21-14
1748 Sun Microsystems Laboratories, Inc.
1749 Mountain View, CA 94043
1750 415/336-1080
1751 with many additional contributors.
1753
1756 Copyright (c) 1988-1991 by Patrick J. Naughton
1757 Copyright (c) 1993-2005 by David A. Bagley
1758 Permission to use, copy, modify, and distribute this software and its
1760 documentation for any purpose and without fee is hereby granted, pro‐
1761 vided that the above copyright notice appear in all copies and that
1762 both that copyright notice and this permission notice appear in sup‐
1763 porting documentation.
1764 The original BSD daemon is Copyright (c) 1988 Marshall Kirk McKusick.
1765 All Rights Reserved.
1766 DEC, HP, IBM, Linux, SCO, SGI, and Sun icons have their respective
1767 copyrights.
1768X11R6 Contrib 7 March 2006 XLOCK(1)