1XLOCK(1)                    General Commands Manual                   XLOCK(1)
2
3
4

NAME

6       xlock - Locks the local X display until a password is entered.
7
8

SYNOPSIS

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       -/+showdate ] [ -/+timeelapsed ] [ -/+usefirst ] [ -/+verbose ] [ -nice
20       level  ] [ -lockdelay seconds ] [ -timeout seconds ] [ -font fontname ]
21       [ -planfont fontname ] [ -bg color ] [ -fg color ] [ -background  color
22       ]  [  -foreground  color  ] [ -username string ] [ -password string ] [
23       -info string ] [ -validate string ] [ -invalid  string  ]  [  -geometry
24       geom  ]  [ -icongeometry geom ] [ -glgeometry geom ] [ -/+wireframe ] [
25       -/+showfps ] [ -fpsfont fontname  ]  [  -/+fpstop  ]  [  -/+use3d  ]  [
26       -delta3d value ] [ -none3d color ] [ -right3d color ] [ -left3d color ]
27       [ -both3d color ] [ -program programname ] [  -messagesfile  formatted-
28       filename ] [ -messagefile filename ] [ -message string ] [ -messagefont
29       fontname ] [  -bitmap  filename  ]  [  -cpasswd  crypted-password  ]  [
30       -forceLogout  minutes  ] [ -logoutButton minutes ] [ -logoutButtonLabel
31       textstring ] [ -logoutButtonHelp  textstring  ]  [  -logoutFailedString
32       textstring  ]  [  -/+dtsaver  ]  [ -/+xinerama ] [ -modulepath path ] [
33       -locksound string ] [ -infosound string ]  [  -validsound  string  ]  [
34       -invalidsound  string  ]  [  -startCmd  string  ]  [ -endCmd string ] [
35       -pipepassCmd string ] [ -logoutCmd string ]
36
37

DESCRIPTION

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
46       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
51       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
55       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
60

NOTE ON ETIQUETTE

62       Xlock  should  not  be  used  on  public terminals when there is a high
63       demand for them.
64
65       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
70

OPTIONS

72       -help
73            Print options and a brief description to standard output.
74
75       -version
76            Print version number (if >= 4.00) to standard output.
77
78       -resources
79            Print default resource file to standard output.
80
81       -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
87       -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
93       -name resourcename
94            resourcename  is  used instead of XLock when looking for resources
95            to configure xlock.
96
97       -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).
100
101       anemone Shows wiggling tentacles.
102
103       ant     Shows Langton's and Turk's generalized ants.
104
105       ant3d   Shows 3D ants.
106
107       apollonian
108               Shows Apollonian circles.
109
110       atlantis
111               Shows  moving  sharks/whales/dolphin.   May  not  be  available
112               depending on how it was configured.
113
114       atunnels
115               Advance GL tunnels screensaver.  May not be available depending
116               on how it was configured.
117
118       ball    Shows bouncing balls.
119
120       bat     Shows bouncing flying bats.
121
122       biof    Shows 3D bioform.
123
124       blot    Shows Rorschach's ink blot test.
125
126       bouboule
127               Shows Mimi's bouboule of moving stars.
128
129       bounce  Shows bouncing footballs.
130
131       braid   Shows random braids and knots.
132
133       bubble  Shows popping bubbles.
134
135       bubble3d
136               Shows Richard Jones's GL bubbles.  May not be available depend‐
137               ing on how it was configured.
138
139       bug     Shows Palmiter's bug evolution and a garden of Eden.
140
141       clock   Shows Packard's oclock.
142
143       coral   Shows a coral reef.
144
145       crystal Shows polygons in 2D plane groups.
146
147       daisy   Shows a meadow of daisies.
148
149       dclock  Shows a floating digital clock or message.
150
151       deco    Shows art as ugly as sin.
152
153       demon   Shows Griffeath's cellular automata.
154
155       dilemma Shows Lloyd's Prisoner's Dilemma simulation.
156
157       discrete
158               Shows various discrete maps.
159
160       dragon  Shows Deventer's Hexagonal Dragons Maze.
161
162       drift   Shows cosmic drifting flame fractals.
163
164       cage    Shows the Impossible Cage, an Escher-like GL scene.  May not be
165               available depending on how it was configured.
166
167       euler2d Shows a simulation of 2D incompressible inviscid fluid.
168
169       eyes    Shows eyes following a bouncing grelb.
170
171       fadeplot
172               Shows a fading plot of sine squared.
173
174       fiberlamp
175               Shows a Fiber Optic Lamp.
176
177       fire    Shows  a 3D fire-like image.  May not be available depending on
178               how it was configured.
179
180       flag    Shows a waving flag image.  This  may  be  text  or  a  graphic
181               image.  Default text is the hostname and operating system.
182
183       flame   Shows cosmic flame fractals.
184
185       flow    Shows dynamic strange attractors.
186
187       forest  Shows binary trees of a fractal forest.
188
189       fzort   Shows a metallic-looking fzort.
190
191       galaxy  Shows crashing spiral galaxies.
192
193       gears   Shows GL's gears.  May not be available depending on how it was
194               configured.
195
196       glplanet
197               Animates texture mapped sphere (planet)
198
199       goop    Shows goop from a lava lamp.
200
201       grav    Shows orbiting planets.
202
203       helix   Shows string art.
204
205       hop     Shows real plane iterated fractals.
206
207       hyper   Shows spinning n-dimensional hypercubes.
208
209       ico     Shows a bouncing polyhedron.
210
211       ifs     Shows a modified iterated function system.
212
213       image   Shows randomly appearing logos.
214
215       juggle  Shows a Juggler, juggling.
216
217       juggle  Shows a 3D Juggler, juggling.
218
219       julia   Shows the Julia set.
220
221       kaleid  Shows Brewster's Kaleidoscope.
222
223       kumppa  Shows kumppa.
224
225       laser   Shows spinning lasers.
226
227       life    Shows Conway's game of life.
228
229       life1d  Shows Wolfram's game of 1D life.
230
231       life3d  Shows Bays' game of 3D life.
232
233       lightning
234               Shows Keith's fractal lightning bolts.
235
236       lisa    Shows animated lissajous loops.
237
238       lissie  Shows lissajous worms.
239
240       loop    Shows Langton's self-producing loops.
241
242       mandelbrot
243               Shows mandelbrot sets.
244
245       marquee Shows text.
246
247       matrix  Shows the matrix.
248
249       maze    Shows a random maze and a depth first search solution.
250
251       moebius Shows the Moebius Strip II, an Escher-like GL scene with  ants.
252               May not be available depending on how it was configured.
253
254       molecule
255               Draws  molecules,  based  on coordinates from PDB (Protein Data
256               Base) files.
257
258       morph3d Shows GL morphing polyhedra.  May not be available depending on
259               how it was configured.
260
261       mountain
262               Shows Papo's mountain range.
263
264       munch   Shows munching squares.
265
266       noof    Shows SGI Diatoms.
267
268       nose    Shows a man with a big nose runs around spewing out text.
269
270       pacman  Shows Pacman(tm).
271
272       penrose Shows Penrose's quasiperiodic tilings.
273
274       petal   Shows various GCD Flowers.
275
276       petri   Shows a mold simultation in a petri dish
277
278       pipes   Shows  a  self-building  pipe  system.   May  not  be available
279               depending on how it was configured.
280
281       polyominoes
282               Shows attempts to place polyominoes into a rectangle.
283
284       puzzle  Shows a puzzle being scrambled and then solved.
285
286       pyro    Shows fireworks.
287
288       pyro2   Shows other fireworks.
289
290       qix     Shows spinning lines a la Qix(tm).
291
292       roll    Shows a rolling ball.
293
294       rain    Shows rain.
295
296       rotor   Shows Tom's Roto-Rooter.
297
298       rubik   Shows an auto-solving  Rubik's  Cube.   May  not  be  available
299               depending on how it was configured.
300
301       sballs  Shows  balls  spinning  like crazy in GL.  May not be available
302               depending on how it was configured.
303
304       scooter Shows a journey through space tunnel and stars.
305
306       shape   Shows stippled rectangles, ellipses, and triangles.
307
308       sierpinski
309               Shows a Sierpinski's triangle.
310
311       sierpinski3d
312               Shows a Sierpinski's gasket.
313
314       skewb   Shows an auto-solving Skewb.  May not be available depending on
315               how it was configured.
316
317       slip    Shows slipping blits.
318
319       solitaire
320               Shows Klondike's game of solitaire.
321
322       space   Shows a journey into deep space.
323
324       sphere  Shows a bunch of shaded spheres.
325
326       spiral  Shows a helical locus of points.
327
328       spline  Shows colorful moving splines.
329
330       sproingies
331               Shows Sproingies!  Nontoxic.  Safe for pets and small children.
332               May not be available depending on how it was configured.
333
334       stairs  Shows Infinite Stairs, an Escher-like GL  scene.   May  not  be
335               available depending on how it was configured.
336
337       star    Shows a star field with a twist.
338
339       starfish
340               Shows starfish.
341
342       strange Shows strange attractors.
343
344       superquadrics
345               Shows  3D  mathematical shapes.  May not be available depending
346               on how it was configured.
347
348       swarm   Shows a swarm of bees following a wasp.
349
350       swirl   Shows animated swirling patterns.
351
352       t3d     Shows a Flying Balls Clock Demo.
353
354       tetris  Shows an autoplaying tetris game.
355
356       text3d | text3d2
357               Shows 3D moving texts.
358
359       thornbird
360               Shows an animated Bird in a Thorn Bush fractal map.
361
362       tik_tak Shows rotating polygons.
363
364       toneclock
365               Shows Peter Schat's toneclock.
366
367       triangle
368               Shows a triangular mountain range.
369
370       tube    Shows an animated tube.
371
372       turtle  Shows turtle fractals.
373
374       vines   Shows fractal-like vines.
375
376       voters  Shows Dewdney's Voters.
377
378       wator   Shows Dewdney's Water-Torus planet of fish and sharks.
379
380       wire    Shows a random circuit with 2 electrons.
381
382       world   Shows spinning Earths.
383
384       worm    Shows wiggly worms.
385
386       xjack   Shows Jack having one of those days.
387
388       xcl     Shows a Control Line combat model race
389
390       blank   Shows nothing but a black screen.  Does not show up  in  random
391               mode.
392
393       bomb    Shows  a  bomb and will autologout after a time.  Does not show
394               up in random mode and may be available depending on how it  was
395               configured.
396
397       random  Shows a random mode from above except blank (and bomb).
398
399
400       -delay usecs
401            The  delay option sets the speed at which a mode will operate.  It
402            simply sets the number of microseconds to delay between batches of
403            animations.   In  blank  mode, it is important to set this to some
404            small number of seconds, because the keyboard and mouse  are  only
405            checked  after  each  delay, so you cannot set the delay too high,
406            but a delay of zero would  needlessly  consume  cpu  checking  for
407            mouse  and keyboard input in a tight loop, since blank mode has no
408            work to do.
409
410       -count num
411            The batchcount option sets number of things to do per batch to num
412            .
413
414            In anenome mode it is means nothing.
415
416            In ant and ant3d modes this refers the number of ants.
417
418            In apollonian mode it is the number of possible ways to imbed cir‐
419            cles within a circle, all of integer curvature.
420
421            In atlantis mode it is the number of sharks.
422
423            In atunnels mode it is means nothing.
424
425            In ball mode it is the number of balls.
426
427            In bat mode it is the number of bats, could  be  less  because  of
428            conflicts.
429
430            In  blot  mode this refers to the number of pixels rendered in the
431            same color.
432
433            In bouboule mode it is the number of stars.
434
435            In bounce mode it is the number of balls, could be less because of
436            conflicts.
437
438            In braid mode it is the upper bound number of strands.
439
440            In bubble mode it is the number of bubbles.
441
442            In bubble3d mode it is the number of bubbles.
443
444            In  bug  mode  it  is the number of bugs, could be less because of
445            conflicts.
446
447            In cage mode it is means nothing.
448
449            In clock mode it is the percentage of the screen,  but  less  than
450            100%.
451
452            In coral mode it is the number of seeds.
453
454            In crystal mode it is the number of polygons.
455
456            In daisy mode it is the number flowers that make a meadow.
457
458            In dclock mode it means nothing.
459
460            In deco mode it is the depth.
461
462            In demon mode this refers the number of colors.
463
464            In dilemma mode this refers the number of initial defectors.
465
466            In discrete mode it is the number of points.
467
468            In drift mode it is the number of levels to recurse (larger = more
469            complex).
470
471            In dragon mode it means nothing.
472
473            In euler2d mode it is the number of segments.
474
475            In eyes mode it is the number of eyes.
476
477            In fadeplot mode it is the number of steps.
478
479            In fiberlamp it is the number of fibers.
480
481            In fire mode it is the number of fire particles (set it  to  0  to
482            have rain).
483
484            In flag mode it means nothing.
485
486            In flame mode it is the number of levels to recurse (larger = more
487            complex).
488
489            In flow mode it is the number of bees.
490
491            In forest mode it is the number trees that make a forest.
492
493            In fzort mode it means nothing.
494
495            In galaxy mode it means the number of galaxies.
496
497            In gears mode it is the number of degrees to  rotate  the  set  of
498            gears by.
499
500            In glplanet mode it is the number of hundredth degrees to roll the
501            planet by.
502
503            In goop mode it is the number of blobs per plane.
504
505            In grav mode it is the number of planets.
506
507            In helix mode it means nothing.
508
509            In hop mode this refers to the number of pixels  rendered  in  the
510            same color.
511
512            In hyper mode it the number of dimensions.
513
514            In ico mode it is the ith platonic solid.
515
516            In ifs mode it means nothing.
517
518            In  image  mode  it  means  it is the number of logos on screen at
519            once.
520
521            In juggle mode it is time in milliseconds between a throw and  the
522            next catch.
523
524            In  juggler3d  mode it is time in milliseconds between a throw and
525            the next catch.
526
527            In julia mode it is the depth of recursion.
528
529            In kaleid mode it is the number of pens.
530
531            In kumppa mode it means nothing.
532
533            In lament mode it means nothing.
534
535            In laser mode it is the number lasers.
536
537            In life and life3d modes it is the number of generations before  a
538            glider is introduced.
539
540            In life1d mode it means nothing.
541
542            In lisa mode it is the number of loops.
543
544            In lissie mode it is the number of worms.
545
546            In loop mode it is the number of flaws.
547
548            In mandelbrot mode it is the order.
549
550            In marquee mode it means nothing.
551
552            In matrix mode it means nothing.
553
554            In maze mode it means nothing.
555
556            In moebius mode it is means nothing.
557
558            In molecule mode it means nothing.
559
560            In morph3d mode it is the ith platonic solid.
561
562            In mountain mode it is the number of mountains.
563
564            In munch mode it means nothing.
565
566            In noof mode it means nothing.
567
568            In nose mode it means nothing.
569
570            In qix mode it is the number of points.
571
572            In pacman mode it means the number of ghosts.
573
574            In penrose mode it means nothing.
575
576            In petal mode it the greatest random number of petals.
577
578            In petri mode it means nothing.
579
580            In  pipes mode it shows different joints, 0 random, 1 spherical, 2
581            bolted elbow, 3 elbow, and 4 alternating.
582
583            In polyominoes mode it means nothing.
584
585            In puzzle mode it the number of moves.
586
587            In pyro mode it is the maximum number flying rockets at one time.
588
589            In pyro2 mode it is means nothing.
590
591            In rain mode it is means nothing.
592
593            In roll mode it is the number of points.
594
595            In rotor mode it is the number of rotor thingys which whirr...
596
597            In rubik mode it is the number of moves.
598
599            In sballs mode it is the number of spheres.
600
601            In scooter mode it is the number of doors.
602
603            In shape mode it means nothing.
604
605            In sierpinski mode it is the number of points.
606
607            In skewb mode it is the number of moves.
608
609            In slip mode it means nothing.
610
611            In solitaire mode it means nothing.
612
613            In space mode it is the number of stars.
614
615            In sphere mode it means nothing.
616
617            In spiral mode it is the number of spirals.
618
619            In spline mode it is the number of points "splined".
620
621            In sproingies mode it is the number of sproingies.
622
623            In stairs mode it is means nothing.
624
625            In star mode it is the number of stars on the screen at once.
626
627            In starfish mode it means nothing.
628
629            In strange mode it means nothing.
630
631            In superquadrics mode its the number of  horizontal  and  vertical
632            lines in the superquadric.
633
634            In swirl mode it means the number of "knots".
635
636            In swarm mode it is the number of bees.
637
638            In t3d mode it means nothing.
639
640            In tetris mode it means nothing.
641
642            In text3d mode it means nothing.
643
644            In thornbird mode it is the number of points.
645
646            In triangular mode it is the number of mountains.
647
648            In tube mode it is a rectangle (= 1), an ellipse (= 2), or a poly‐
649            gon if greater.
650
651            In turtle mode it means nothing.
652
653            In vines mode it is draw a complete vine (= 0) or a portion (= 1).
654
655            In voters mode it means the number of parties, 2 or 3.
656
657            In wator mode it means the breed time for the fish.
658
659            In wire mode it means the length of the circuit.
660
661            In world mode it is the number of worlds.
662
663            In worm mode it is the number of worms.
664
665            In xcl mode it represents the number of planes.
666
667            In xjack mode it means nothing.
668
669            In blank mode it means nothing.
670
671            In bomb mode it means the number of minutes to autologout.
672
673            A negative count allows for randomness.  The range from the  mini‐
674            mum  allowed  nonnegative  count for a particular mode to the ABS(
675            count ) (or maximum allowed count , whichever is less).
676
677       -batchcount num
678            The batchcount option is  deprecated  but  should  still  work  as
679            count.
680
681       -cycles num
682            The  cycles  option  sets  the number of cycles until time out for
683            ant, ant3d, apollonian, blot, braid, bug, clock,  crystal,  daisy,
684            deco,  demon,  dilemma,  discrete,  dragon, eyes, fiberlamp, flag,
685            flow, forest, galaxy, helix, hop, hyper, ico,  juggle,  juggler3d,
686            laser, life, life1d, life3d, lisa, lissie, loop, mandelbrot, moun‐
687            tain, petal, sierpinski, shape,  spline  +erase,  t3d,  thornbird,
688            triangle,  tube, voters, wator, and wire.  For euler2d and worm it
689            is the length of the lines, for atlantis it is  the  shark  speed,
690            for  fadeplot,  julia  and spiral it is the length of the trail of
691            dots, munch it is the minimum size of the squares, for  kaleid  it
692            is  the  % of black, for qix it is the number of lines, for spline
693            -erase it means the number of splines * 64 (for compatibility with
694            +erase),  for  gears  it is the number of degrees to increment the
695            spin of each gear by, for glplanet it is the number  of  hundredth
696            degrees  to  rotate  the planet by, for molecule it is the time in
697            seconds until timeout, for pipes it is the number  of  systems  to
698            draw  before  clearing  the  screen, for rubik it is the number of
699            steps to complete a 90 degree move, for sballs it  is  the  sphere
700            speed value, for scooter it is the speed, for skewb it is the num‐
701            ber of steps to complete a 120 degree move, for  superquadrics  it
702            is  the  number  of  frames  it  takes  to morph from one shape to
703            another.  for text3d it is the number  of  times  drawing  a  word
704            before the next one, For others it means nothing.
705
706       -size num
707            The  size option sets the size maximum size of a star in bouboule,
708            pyro and star, size of ball in ball and bounce,  size  of  bat  in
709            bat,  maximum  size  of  bubble in bubble, size of clock in clock,
710            minimum size of rectangles in deco, size of the polygons in  crys‐
711            tal,  tik_tak,  and  toneclock, size of polyhedron in ico, size of
712            lissie in lissie, size of dots of flag, for kaleid it is the  sym‐
713            metry, width of maze hallway, size of side of penrose tile, radius
714            of loop in lisa, radius of ball in  roll,  number  of  corners  in
715            sierpinski,  number  of  stars  in  scooter, size of tube in tube,
716            width of worm in worm, line width in rotor, size of cells in  ant,
717            bug, dilemma, dragon, life, life1d, pacman, petri, tetris, voters,
718            wator, and wire.  In pipes it is the maximum length of  a  system.
719            In  flow  and swarm it is the length of the lines.  In atlantis it
720            is the shark size.  A negative number allows for randomness, simi‐
721            lar  to count.  In atunnels, fire, gears, sballs and sproingies it
722            is the size of the screen (default 400), this is because  on  many
723            slow  systems  it  runs  too slow when the picture covers the full
724            screen.  Set to 0 for full screen on fast machines.
725
726       -ncolors num
727            The ncolors option sets the maximum number of colors to be used.
728
729       -saturation value
730            The saturation option sets saturation of the color  ramp  used  to
731            value  .   0 is grayscale and 1 is very rich color.  0.4 is a nice
732            pastel.
733
734       -erasemode modename
735            As of this writing there are over 12 erase modes supported (if its
736            not chosen its assumed random).  The erase modes are random_lines,
737            random_squares,  venetian,  triple_wipe,  quad_wipe,  circle_wipe,
738            three_circle_wipe,   squaretate,   fizzle,   spiral,  slide_lines,
739            losira, no_fade.  modename is now similar to the  option  modelist
740            where  you  can  it  can be something like "all-losira" to get all
741            erasemodes but losira.  Use a "+" or a "," to add modes like "spi‐
742            ral+venetian".
743
744       -erasedelay usecs
745            The erasedelay option sets the number of microseconds for steps of
746            the erasemode (a setting of 0 and the erasemode is bypassed).
747
748       +/-nolock
749            The nolock option causes xlock to only draw the patterns  and  not
750            lock the display.  A key press or a mouse click will terminate the
751            screen saver.
752
753       -/+inwindow
754            Runs xlock in a window, so that you can iconify, move,  or  resize
755            it  and  still use your screen for other stuff.  When running in a
756            window, xlock no longer locks your screen, it just looks good.
757
758       -/+inroot
759            Runs xlock in your root window.  Like the inwindow  option  it  no
760            longer locks the screen, it just looks good.
761
762       -/+remote
763            The  remote option tells xlock to not stop you from locking remote
764            X11 servers.  This option should be used with care and is intended
765            mainly  to  lock X11 terminals which cannot run xlock locally.  If
766            you lock someone else's workstation, they will have to  know  your
767            password  to  unlock  it.   Using  +remote  overrides any resource
768            derived values for remote and prevents xlock from  being  used  to
769            lock  other  X11  servers.   (Use  `+'  instead of `-' to override
770            resources for other options that can take the `+'  modifier  simi‐
771            larly.)
772
773       -/+mono
774            The  mono  option  causes  xlock to display monochrome, (black and
775            white) pixels rather than the default colored ones on  color  dis‐
776            plays.
777
778       -/+allowaccess
779            This  option is required for servers which do not allow clients to
780            modify the host access control list.  It is  also  useful  if  you
781            need  to  run  x clients on a server which is locked for some rea‐
782            son...  When allowaccess is true, the X11 server is left open  for
783            clients  to  attach  and thus lowers the inherent security of this
784            lock screen.  A side effect of using this option is that if  xlock
785            is killed -KILL, the access control list is not lost.
786
787       -vtlock modename
788            This  option is used on a XFree86 system to manage VT switching in
789            [off|noswitch|switch|restore] mode.
790
791       off       means no VT switch locking.
792
793       switch    means VT switch locking + switching to xlock  VT  when  acti‐
794                 vated.
795
796       restore   means  VT  switch  locking + switching to xlock VT when acti‐
797                 vated + switching back to previous VT when desactivated.
798
799       noswitch  means VT switch locking only when xlock VT is active.
800
801       -/+allowroot
802            The allowroot option allows the root password to unlock the server
803            as  well  as  the user who started xlock.  May not be able to turn
804            this on and off depending on your system and how xlock was config‐
805            ured.
806
807       -/+debug
808            Allows xlock to be debugged by doing all but locking the screen.
809
810       -/+description
811            The description option causes xlock shows a mode description above
812            password window.  The default is to show this description.
813
814       -/+echokeys
815            The echokeys option causes xlock to echo '?' characters  (default)
816            for each key typed into the password prompt.  Some consider this a
817            security risk, so the default is to not echo anything.
818
819       -echokey echokey
820            The text character to use for echo key in echokeys .
821
822       -/+enablesaver
823            By default xlock will disable the normal X server's  screen  saver
824            since  it is in effect a replacement for it.  Since it is possible
825            to set delay parameters long enough to cause phosphor burn on some
826            displays,  this  option will turn back on the default screen saver
827            which is very careful to keep most of the screen black.
828
829       -/+resetsaver
830            By default xlock will call XResetScreenSaver.  This may  be  unde‐
831            sirable with DPMS monitors.
832
833       -/+grabmouse
834            The  grabmouse option causes xlock to grab the mouse and keyboard,
835            this is the default.  xlock can not lock the screen without this.
836
837       -/+grabserver
838            The grabserver option causes xlock to grab the  server.   This  is
839            not  usually  needed  but  some unsecure X servers can be defeated
840            without this.
841
842       -/+install
843            Allows xlock to install its own colormap if xlock runs out of col‐
844            ors.   May  not  work on with some window managers (fvwm) and does
845            not work with the -inroot option.
846
847       -/+mousemotion
848            Allows you to turn on and off the  sensitivity  to  the  mouse  to
849            bring up the password window.
850
851       -/+sound
852            Allows you to turn on and off sound if installed with the capabil‐
853            ity.
854
855       -/+showdate
856            Allows you to turn on and off the date on password window.  On  by
857            default.
858
859       -/+timeelapsed
860            Allows  you  to  find  out how long a machine is locked so you can
861            complain to an administrator that someone is hogging a machine.
862
863       -/+usefirst
864            The usefirst option causes xlock to use the  keystroke  which  got
865            you to the password screen as the first character in the password.
866            The default is to ignore the first key pressed.
867
868       -/+verbose
869            Verbose mode, tells what options it is going to use.
870
871       -nice nicelevel
872            The nice option sets system nicelevel  of  the  xlock  process  to
873            nicelevel .
874
875       -lockdelay seconds
876            The  lockdelay option sets the number of seconds before the screen
877            needs a password to be unlocked.  Good for use with an autolocking
878            mechanism like xautolock(1).
879
880       -timeout seconds
881            The  timeout option sets the number of seconds before the password
882            screen will time out.
883
884       -font fontname
885            The font option sets the font to be used on the prompt screen.
886
887       -planfont fontname
888            option sets the font to be used for the text that is displayed  in
889            the lower part of the password screen.
890
891       -fg color
892            The fg option sets the color of the text on the password screen to
893            color .
894
895       -bg color
896            The bg option sets the color of the  background  on  the  password
897            screen to color .
898
899       -foreground color
900            The  foreground  option sets the color of the text on the password
901            screen to color .
902
903       -background color
904            The background option sets the color  of  the  background  on  the
905            password screen to color .
906
907       -username string
908            Text string is shown in front of user name, defaults to "Name: ".
909
910       -password string
911            Text  string is the password prompt string, defaults to "Password:
912            ".
913
914       -info string
915            Text string is an informational message to tell the user  what  to
916            do, defaults to "Enter password to unlock; select icon to lock.".
917
918       -validate string
919            Text  string  is  a  message  shown while validating the password,
920            defaults to "Validating login..."
921
922       -invalid string
923            Text string is a message shown when password is invalid,  defaults
924            to "Invalid login."
925
926       -geometry geom
927            The geometry option sets geom the size and offset of the lock win‐
928            dow (normally the entire screen).  The  entire  screen  format  is
929            still  used  for entering the password.  The purpose is to see the
930            screen even though it is locked.  This should be used with caution
931            since  many  of  the  modes  will fail if the windows are far from
932            square or are too small (size must be  greater  than  0x0).   This
933            should also be used with -enablesaver to protect screen from phos‐
934            phor burn.
935
936       -icongeometry geom
937            The icongeometry option sets geom the size of  the  iconic  screen
938            (normally  64x64) seen when entering the password.  This should be
939            used with caution since many of the modes will fail if the windows
940            are  far  from  square or are too small (size must be greater than
941            0x0).  The greatest size is 256x256.  There should be  some  limit
942            so  users  could see who has locked the screen.  Position informa‐
943            tion of icon is ignored.
944
945       -glgeometry geom
946            The glgeometry option sets geom the size  of  the  screen  for  gl
947            modes.  Not normally available or needed.
948
949       -/+wireframe
950            Turn  on/off  wireframe,  available  on ant3d, atlantis, atunnels,
951            daisy, fire, gears, lament, life3d, mountain, sballs,  sproingies,
952            superquadrics, and triangle.
953
954       -/+showfps
955            Turn  on/off  frame  per sec display, available on atlantis, atun‐
956            nels,  bubble3d,  cage,  fire,  gears,  invert,  lament,  moebius,
957            morph3d, rubik, sballs, skewb, stairs, and superquadrics.
958
959       -/+fpstop
960            Turn  on/off  frame  per  sec  display  on  top of screen, used if
961            showfps is on.
962
963       -fpsfont fontname
964            The fpsfont option sets the font to be used in the frame  per  sec
965            display, used if showfps is on.
966
967       -/+use3d
968            Turn on/off 3d view, available on bouboule, pyro, star, and worm.
969
970       -delta3d value
971            Space between the center of your 2 eyes for 3d mode.
972
973       -none3d color
974            Color used for empty size in 3d mode.
975
976       -right3d color
977            Color used for right eye in 3d mode.
978
979       -left3d color
980            Color used for left eye in 3d mode.
981
982       -both3d color
983            Color  used  for  overlapping  images for left and right eye in 3d
984            mode.
985
986       -program programname
987            The program option sets the program to be used as the fortune gen‐
988            erator.  Currently used only for marquee and nose modes.
989
990       -messagesfile formatted-filename
991            The  messagesfile  option  sets the file to be used as the fortune
992            generator.  The first entry is the number of  fortunes,  the  next
993            line  contains the first fortune.  Fortunes begin with a "%%" on a
994            line by itself.  Currently used only for marquee and  nose  modes.
995            If one exists, it takes precedence over the fortune program.
996
997       -messagefile filename
998            The messagefile option sets the file whose contents are displayed.
999            Currently used only for marquee and nose modes.  If one exists, it
1000            takes precedence over the fortune program and messagesfile.
1001
1002       -message textstring
1003            The  message option sets the text to be displayed in a mode.  Cur‐
1004            rently used only for flag, marquee and nose modes.  If one exists,
1005            it  takes  precedence  over  the fortune program, messagesfile and
1006            message.
1007
1008       -messagefont fontname
1009            The messagefont option sets the font to be used in the mode.  Cur‐
1010            rently used only for flag, marquee, and nose modes.
1011
1012       -bitmap filename
1013            The  bitmap  option sets the xbm, xpm, or ras file to be displayed
1014            with flag, image, life, life1d, maze, or puzzle  mode.   For  eyes
1015            and  pacman only a xbm file is accepted.  Certain modes reject the
1016            bitmap if too big.  /
1017
1018

MORE OPTIONS (these may not be available)

1020       -cpasswd crypted-password
1021            The cpasswd option sets the key to be this text string  to  unlock
1022            xlock instead of password file.
1023
1024       -forceLogout minutes
1025            The forceLogout option sets minutes to auto-logout.
1026
1027       -logoutButton minutes
1028            The  logoutButton option sets minutes to logoutButton is available
1029            on password screen.
1030
1031       -logoutButtonLabel string
1032            Text string is a message shown inside logout  button  when  logout
1033            button is displayed.  Defaults to "Logout".
1034
1035       -logoutButtonHelp string
1036            Text  string  is a message shown outside logout button when logout
1037            button is displayed.  Defaults to "Click the \"Logout\" button  to
1038            log out current\n user and make workstation available."
1039
1040       -logoutFailedString string
1041            Text  string  is  a  message  shown when a logout is attempted and
1042            fails.  Defaults to "Logout attempt FAILED.\n Current  user  could
1043            not be automatically logged out."
1044
1045       -/+dtsaver
1046            Turn  on/off CDE Saver Mode.  This option is only available if CDE
1047            support was compiled in.
1048
1049       -/+xinerama
1050            Turn on/off Xinerama.  This option is only available  if  Xinerama
1051            support was compiled in.
1052
1053       -modulepath path
1054            The modulepath option sets the directories that xlock searches for
1055            mode modules to load.  It is a colon separated list of directories
1056            to  search. If "%S" is included in the path, it is replaced by the
1057            default modulepath.  To add a  private  module  directory  to  the
1058            default  path,  use something like '%S:~/mymoduledir' as the path.
1059            This option is only available if module support was compiled in.
1060
1061       -locksound string
1062            Text string references sound to use at lock time.  Default  sound,
1063            male voice: "Thank you, for your cooperation."
1064
1065       -infosound string
1066            Text  string  references  sound  to  use for information.  Default
1067            sound, male voice: "Identify please."
1068
1069       -validsound string
1070            Text string references sound to when a password is valid.  Default
1071            sound, female voice: "Complete."
1072
1073       -invalidsound string
1074            Text  string  references  sound  to  when  a  password is invalid.
1075            Default sound, female voice: "I am not programmed to give you that
1076            information."
1077
1078       -startCmd string
1079            Text string command to execute when the screen is locked. Commonly
1080            used instructions include: "zaway". This command, if still running
1081            when the screensaver exits, will be killed.
1082
1083       -endCmd string
1084            Text string command to execute when the screen is unlocked.
1085
1086       -pipepassCmd string
1087            Text  string  command  into  which  to  pipe the password when the
1088            screen is unlocked.
1089
1090       -logoutCmd string
1091            Text string command to execute when the program logs the user  out
1092            (either via the autologout or by pressing the logout button).
1093
1094       -mailCmd string
1095            Text string command to execute when the program to check mail.
1096
1097       -mailIcon string
1098            Text string of file for the "mail arrived" bitmap.
1099
1100       -nomailIcon string
1101            Text string of file for the "no mail" bitmap.
1102
1103       -dpmsstandby  seconds
1104            Allows  one to set DPMS Standby for monitor (0 is defined as infi‐
1105            nite).  (Horizontal sync on, Vertical  sync  off,  RGB  guns  off,
1106            power  supply  on,  tube filaments energized, (screen saver mode).
1107            Typical 17 inch screen...  110 out of  120  watts  with  a  3  sec
1108            recovery time.)  This option is only available if DPMS support was
1109            compiled in.
1110
1111       -dpmssuspend  seconds
1112            Allows one to set DPMS Suspend for monitor (0 is defined as  infi‐
1113            nite).   (Horizontal  sync  off,  Vertical  sync on, RGB guns off,
1114            power supply off,  tube  filaments  energized.   Typical  17  inch
1115            screen ...  15 out of 120 watts with a 3 sec recovery time.)  This
1116            option is only available if DPMS support was compiled in.
1117
1118       -dpmsoff  seconds
1119            Allows one to set DPMS Power Off for  monitor  (0  is  defined  as
1120            infinite).   (Horizontal sync off, Vertical sync off, Small auxil‐
1121            iary circuit stays on to monitor the HS/VS signals to enable power
1122            on when data needs to be displayed on the screen.  Typical 17 inch
1123            screen ...  5 out of 120 watts with a 10 sec recovery time.)  This
1124            option is only available if DPMS support was compiled in.
1125
1126

SPECIAL MODE DEPENDENT OPTIONS

1128       -neighbors num
1129            The  neighbors option sets the number of neighbors of a cell to 3,
1130            4, 6, 9 (may not have real mathematical meaning), or 12  for  sev‐
1131            eral automata modes (ant, bug, demon, dilemma, life, loop, voters,
1132            wator, and wire) (bug and loop do not span this full range).  Set‐
1133            ting  it  to 0 typically randomizes this, except where bitmaps are
1134            used (dilemma, life, voters, and wator).
1135
1136       -/+eyes
1137            Turn on and off eyes for ant, ant3d, and bug.
1138
1139       -/+cycle
1140            Turn on and off colour cycling in crystal,  lyapunov,  mandelbrot,
1141            starfish, swirl, tetris, tik_tak, toneclock, and tube.
1142
1143       -/+label
1144            Turn on and off alternate space and number labeling in apollonian.
1145            For ant and ant3d this turns on and off the labeling of the  rule.
1146            For life and life3d this turns on and off the labeling of the pat‐
1147            tern name and rule.
1148
1149       -/+serial
1150            Turn on and off sequential allocation of colors  in  kaleid.   For
1151            life  and  life3d  this turns on and off the picking of sequential
1152            patterns (to be used with middle button of the mouse).
1153
1154       -/+trackmouse
1155            Turn on and off mouse interaction in eyes, fire, julia, solitaire,
1156            sballs, swarm, and tetris.  For maze, pacman, solitaire and tetris
1157            this may not be available depending on how xlock was configured.
1158
1159       -/+texture
1160            Turn on and off texturing in fire, lament and  sballs.   This  may
1161            not be available depending on how xlock was configured.
1162
1163       -rule <rule>
1164            The  rule string is defined as S<neighborhood>/B<neighborhood> for
1165            life and life3d.  Special parameters: P, picks a random rule  from
1166            all  rules  that  have known patterns; G, picks a random rule from
1167            all rules that have known gliders.  For life  a  good  example  is
1168            Conway's   rule   which   is   S23/B3.   Others  are  B36/S23  and
1169            B3678/S34678.  For life3d good examples are Bay's rules which  are
1170            S45/B5,  S567/B6, S56/B5, and S67/B67.  The rule string is defined
1171            as a binary string (requires at least one 1 and one 0) for ant and
1172            a base 4 (or quadranary) string (requires 3 of 4 digits to be rep‐
1173            resented) for ant3d.  Here a special parameter, T and then a  num‐
1174            ber, will pick a specific table.
1175
1176       -lifefile filename
1177            The  lifefile  option sets the life and life3d lifeform.  Only one
1178            format is currently supported, similar to  the  #P  xlife  format.
1179            For life3d, 2 linefeeds in a row are assumed to advance the depth.
1180
1181       -arms num
1182            Allows one to set the number of arms in anemone.
1183
1184       -finpoints num
1185            Allows one to set the width of the arms in anemone.
1186
1187       -width num
1188            Allows  one  to  set  the  final number of points in each array of
1189            anemone.
1190
1191       -withdraws num
1192            Allows one to set the withdraw frequency in
1193
1194       anemone.
1195            -turnspeed num Allows one to set the turning speed in
1196
1197       -/+truchet
1198            Turn on and off Truchet lines (trail) in ant.
1199
1200       -/+altgeom
1201            Turn on and off alternate  geometries  (off  euclidean  space,  on
1202            includes spherical and hyperbolic) in apollonian mode.
1203
1204       -whalespeed num
1205            Allows one to set the speed of the whales and dolphin in atlantis.
1206
1207       -/+boil
1208            Turn on and off having the bubbles bubble up in bubble.
1209
1210       -nx num
1211            Allows one to set the number of unit cells in x-direction in crys‐
1212            tal.
1213
1214       -ny num
1215            Allows one to set the number of unit cells in y-direction in crys‐
1216            tal.
1217
1218       -/+centre
1219            Turn on and off the centering on screen in crystal.
1220
1221       -/+maxsize
1222            Turn on and off the centering on screen in crystal.
1223
1224       -/+cell
1225            Turn on and off the drawing of unit cell in crystal.
1226
1227       -/+grid
1228            Turn  on and off the drwing of grid of unit cells (if -cell is on)
1229            in crystal.
1230
1231       -/+garden
1232            Turn off and on garden look in daisy.
1233
1234       -/+binary
1235            Turn on and off the binary clock in dclock.
1236
1237       -/+led
1238            Turn on and off the led clock in dclock.
1239
1240       -/+popex
1241            Turn on and off the population explosion counter in dclock.
1242
1243       -/+forest
1244            Turn on and off the tropical deforest (hectares/acres) counter  in
1245            dclock.
1246
1247       -/+hiv
1248            Turn on and off the HIV infection counter in dclock.
1249
1250       -/+lab
1251            Turn on and off the Animal Research counter in dclock.
1252
1253       -/+veg
1254            Turn on and off the Animal Consumation counter in dclock.
1255
1256       -/+y2k
1257            Turn on and off the Year 2000 countdown in dclock.
1258
1259       -/+millennium
1260            Turn  on and off the Second Millennium (January 1, 2001) countdown
1261            in dclock.
1262
1263       -bonus value
1264            Allows one to set the bonus for cheating... between 1.0 and 4.0 in
1265            dilemma.
1266
1267       -/+conscious
1268            Turn off and on self-awareness in dilemma.
1269
1270       -/+grow
1271            Turn  on  and  off  growing  fractals (else they are animated) for
1272            drift.
1273
1274       -/+liss
1275            Turn on and off using lissajous figures to get points for drift.
1276
1277       -/+fog
1278            Turn on and off fog for fire.
1279
1280       -/+shadows
1281            Turn on and off shadows for fire.
1282
1283       -trees num
1284            Validate the displaying of trees for fire if greater than zero.
1285
1286       -/+invert
1287            Turn on and off inverting of the flag.
1288
1289       -/+rotate
1290            Turn on/off rotating around attractor in flow.
1291
1292       -/+ride
1293            Turn on/off rideing in the flow.
1294
1295       -/+box
1296            Turn on/off bounding box in flow.
1297
1298       -/+periodic
1299            Turn on/off periodic attractors in flow.
1300
1301       -/+search
1302            Turn on/off search for new attractors in flow.
1303
1304       -/+dbuf
1305            Turn on/off double buffering in flow.
1306
1307       -/+tracks
1308            Turn on and off star tracks in galaxy.
1309
1310       -/+light
1311            Turn on and off lighting of the planet for glplanet.
1312
1313       -/+bounce
1314            Turn on and off bouncing movement of the planet for glplanet.
1315
1316       -pimage filename
1317            Use the named xbm  or  xpm  file  for  texturing  the  planet  for
1318            glplanet.   Use  BUILTIN  as  filename for the builtin image taken
1319            from Xearth.
1320
1321       -/+roll
1322            Turn on and off rolling of the planet for glplanet.
1323
1324       -/+rotate
1325            Turn on and off rotation of the planet for glplanet.
1326
1327       -/+texture
1328            Turn on and off texturing of the planet for glplanet.
1329
1330       -/+stars
1331            Turn on and off showing stars in the background for glplanet.
1332
1333       -/+decay
1334            Turn on and off decaying orbits for grav.
1335
1336       -/+trail
1337            Turn on and off decaying trail of dots for grav.
1338
1339       -/+ellipse
1340            Turn on and off ellipse format in helix.
1341
1342       -/+martin
1343            Turn on and off Barry Martin's square root hop.   -/+popcorn  Turn
1344            on and off Clifford A. Pickover's popcorn hop.
1345
1346       -/+ejk1...ejk6
1347            Turn on and off Ed J. Kubaitis' hops.
1348
1349       -/+rr
1350            Turn on and off Renaldo Recuerdo's hop.
1351
1352       -/+jong
1353            Turn on and off Jong's hop.
1354
1355       -/+sine
1356            Turn on and off Barry Martin's sine hop.
1357
1358       -pattern <pattern>
1359            Allows one to set the pattern for juggle.
1360
1361       -tail num
1362            Minimum Trail Length for juggle.
1363
1364       -/+real
1365            Turn  on/off  real-time  juggling  for juggle.  Deprecated.  There
1366            should be no need to turn off real-time  juggling,  even  on  slow
1367            systems.  Adjust speed using -count.
1368
1369       -/+describe
1370            Turn on/off pattern descriptions in juggle.
1371
1372       -/+balls
1373            Turn on/off Balls in juggle.
1374
1375       -/+clubs
1376            Turn on/off Clubs in juggle.
1377
1378       -/+torches
1379            Turn on/off Flaming Torches in juggle.
1380
1381       -/+knives
1382            Turn on/off Knives in juggle.
1383
1384       -/+rings
1385            Turn on/off Rings in juggle.
1386
1387       -/+bballs
1388            Turn on/off Bowling Balls in juggle.
1389
1390       -/+planetary
1391            Turn on and off planetary gears in gears.
1392
1393       -planetsize num
1394            Sets  the  size of the screen for planetary option in gears.  This
1395            is for machines with slower CPU. (Set to 0 for full screen).
1396
1397       -/+disconnected
1398            Turn on and off disconnected pen movement in kaleid.
1399
1400       -/+alternate
1401            Turn on and off alternate rotated display mode kaleid.
1402
1403       -/+quad
1404            Turn on and off quad mirrored/rotated mode similar to  size  4  in
1405            kaleid.
1406
1407       -/+oct
1408            Turn  on  and  off  oct mirrored/rotated mode similar to size 8 in
1409            kaleid.
1410
1411       -/+linear
1412            Turn on and off Cartesian/Polar coordinate mode in kaleid.
1413
1414       -/+conway
1415            Turn on and off John Conway's original Life rule S23/B3 life.
1416
1417       -/+highlife
1418            Turn on and off David Bell's HighLife rule S23/B36 life.
1419
1420       -/+daynight
1421            Turn on and off Nathan Thompson's Day and Night rule  S34678/B3678
1422            life.
1423
1424       -/+callahan
1425            Turn on and off Paul Callahan's S2b34/B2a hexagonal life.
1426
1427       -/+andreen
1428            Turn on and off Bob Andreen's S2a2b4a/B2a3a4b hexagonal life.
1429
1430       -/+trilife
1431            Turn on and off Carter Bays' S34/B45 triangular life.
1432
1433       -/+trilife1
1434            Turn on and off Carter Bays' S45/B456 triangular life.
1435
1436       -/+trilife2
1437            Turn on and off Carter Bays' S23/B45 triangular life.
1438
1439       -/+totalistic
1440            Turn  on and off totalistic rules for life1d.  If this is off then
1441            it follows rules of the LCAU collection.  These rules may  not  be
1442            symmetric and are more general.
1443
1444       -/+additive
1445            Turn on and off additive functions mode in lisa.
1446
1447       -/+dissolve
1448            Turn on and off disolving state in loop.
1449
1450       -/+evolve
1451            Turn on and off Evolving Loops in loop.
1452
1453       -/+langton
1454            Turn on and off Langton Loops for loop.
1455
1456       -/+sheath
1457            Turn on and off sheath extension for loop.
1458
1459       -/+wrap
1460            Turn on and off wrapping of borders for loop.
1461
1462       -increment num
1463            Sets the option for increasing orders in mandelbrot.
1464
1465       -/+alpha
1466            Turn  on  and  off  interior displaying level of closest return in
1467            mandelbrot.
1468
1469       -/+binary
1470            Turn on and off binary decomposition color modulation  in  mandel‐
1471            brot.
1472
1473       -/+dem
1474            Turn on and off Distance Estimator Method (instead of escape time)
1475            in mandelbrot.
1476
1477       -/+index
1478            Turn on and off interior displaying iteration of closest return in
1479            mandelbrot.
1480
1481       -/+lyap
1482            Turn  on  and  off interior displaying according to an estimate of
1483            the Lyapunov exponent in mandelbrot.
1484
1485       -/+pow
1486            Turn on and off adding z^z in mandelbrot.
1487
1488       -/+sin
1489            Turn on and off adding sin(z) in mandelbrot.
1490
1491       -/+noants
1492            Turn off and on ants in moebius.
1493
1494       -/+solidmoebius
1495            Turn on and off solid Mobius strip in moebius.
1496
1497       -/+atoms
1498            Turn on and off the drawing of spheres for the atoms in molecule.
1499
1500       -/+bbox
1501            Turn on and off showing the molecules in a blue box in molecule.
1502
1503       -/+bonds
1504            Turn on and off the drawing of the atomic bonds in molecule.
1505
1506       -molecule filename
1507            Read a molecule structure from a pdb file in molecule.
1508
1509       -/+labels
1510            Turn on and off the labeling of the atoms in molecule.
1511
1512       -spin{x|y|z}
1513            Set the axis for molecule rotation in molecule.   The  default  is
1514            "XYZ".
1515
1516       +spin
1517            Turn off the molecule rotation in molecule.
1518
1519       -/+titles
1520            Turn on and off the molecule description in molecule.
1521
1522       -/+wander
1523            Turn  on  and  off the moving of the molecule on a sinoid curve in
1524            molecule.  Turn on and off movements in fire.
1525
1526       -/+ammann
1527            Turn on and off lines for penrose.
1528
1529       -increment value
1530            Allows fine adjustments to order in mandelbrot.
1531
1532       -/+erase
1533            Turn on and off erasing for spline.  If this option is on,  cycles
1534            is  divided by 64 to compute the number of lines, so as to be com‐
1535            patible when using -fullrandom.
1536
1537       -factory num
1538            Number of extra factory parts in pipes.
1539
1540       -/+fisheye
1541            Turn on if you want a zoomed-in view of pipes.
1542
1543       -/+tightturns
1544            Turn on if you want the pipes to bend more often.
1545
1546       -/+rotatepipes
1547            Turn on if you want the pipe system rotated in pipes.
1548
1549       -/+complete
1550            Turn on or off complete graph morphing in qix.
1551
1552       -msg textstring
1553            Allows one to pass different explosion  elements  to  pyro2.   The
1554            explosion types is one of &0, &1, ... &9, &a, ... &f each of which
1555            presents a different type of explosion.  Normal text can be  sent,
1556            the string may contain blanks if quoted.  An operation system logo
1557            will be shown, if the # sign is sent.
1558
1559       -fnt font
1560            Allows one to pass different elements to pyro2.
1561
1562       -size[xyz] num
1563            Number represents the number of cubies on the x,  y,  or  z  axis.
1564            Negative  numbers offer randomness from 2 to the absolute value of
1565            the number.  star.
1566
1567       -/+hideshuffling
1568            Turn on or off hidden shuffle phase for rubik and skewb.
1569
1570       -/+border
1571            Turn on or off borders in shape.
1572
1573       -/+shadowing
1574            Turn on or off shadowing in shape.
1575
1576       -/+stippling
1577            Turn on or off stippling in shape.
1578
1579       -intensity value
1580            Set the brightness (default 2185) of the sierpinski structure  for
1581            sierpinski3d.
1582
1583       -maxdepth value
1584            Set  the  maximum depth (up to 10) of the sierpinski structure for
1585            sierpinski3d.
1586
1587       -speed value
1588            Determines after how much steps the  depth  changes  for  sierpin‐
1589            ski3d.
1590
1591       -trek num
1592            If  its  a high number you will see the space ship all the time in
1593            star.
1594
1595       -/+rock
1596            Turn on and off rocks for star.  If this is  off,  stars  will  be
1597            seen instead.
1598
1599       -/+straight
1600            Turn on if star gets you motion sick.
1601
1602       -cyclepeed num
1603            Set speed of cycling in starfish.
1604
1605       -rotation num
1606            Set rotation velocity in starfish.
1607
1608       -thickness num
1609            Set thickness in starfish.
1610
1611       -/+rock
1612            Turn on and off blob for starfish.
1613
1614       -spinspeed num
1615            Set speed of rotation, in degrees per frame for superquadrics.
1616
1617       -/+bonus
1618            Turn on in tetris to see 5 square bonus pieces.
1619
1620       -/+well
1621            Turn on in tetris to see welltris.
1622
1623       -ttfont filename
1624            Sets the True Type font file (or font directory) used for text3d
1625
1626       -extrusion num
1627            Sets length of the text extrusion for text3d
1628
1629       -rot_amplitude float
1630            Sets rotation amplitude value of each letter for text3d
1631
1632       -rot_frequency float
1633            Sets rotation frequency for text3d
1634
1635       -/+no_split
1636            Turn on and off word splitting for text3d
1637
1638       -ttanimate function_name
1639            Sets  the  animation function used for text3d.  Currently one of :
1640            Random   FullRandom   Default   Default2   None    Crazy    UpDown
1641             Extrude  RotateXY  RotateYZ  Frequency  Amplitude
1642
1643       -speed km/h
1644            The speed for all planes in km/h for xcl.
1645
1646       -frametime microseconds
1647            The  time for one frame on the screen. This time is used to calcu‐
1648            late the delay time and depends on the speed of the X  server  for
1649            xcl.
1650
1651       -line_length mm
1652            The distance between the pilot and the plane for xcl.
1653
1654       -spectator mm
1655            The distance between spectator and pilot. It should be grater than
1656            the line_length and the half wing width of the  plane  to  be  not
1657            dangerous for the spectator for xcl.
1658
1659       -viewmodel
1660            Shows an animated view of one model for xcl.
1661
1662       -/+oldcolor
1663            Sets  the  colors for the first two planes fixed to red and yellow
1664            in xcl.
1665
1666       -xcldebug
1667            Shows some additional timing information to  make  sure  that  the
1668            calibrate procedure goes right in xcl.
1669
1670       -automatic
1671               The auto scale for automatic fit into the window is Deactivated
1672               with this option for xcl.
1673
1674       -randomstart
1675            Use a random start point for models at startup for xcl.
1676
1677       -preset  num
1678            Use the preset num [1-5] for biof.
1679
1680       -lines  num
1681            Use num lines in biof.
1682
1683       -points  num
1684            Use num points in biof.
1685
1686       -/+offangle
1687            Use offangle in biof.
1688
1689       -duration seconds
1690            Allows one to set a duration for a mode in random.  Duration of  0
1691            is defined as infinite.
1692
1693       -/+fullrandom
1694            Turn on/off randomness options within modes in random.  Not imple‐
1695            mented for all mode options.
1696
1697       -modelist textstring
1698            Allows one to pass a list of files to randomly display to  random.
1699            "all"  will  get  all  files  but blank (and bomb if compiled in).
1700            "all,blank" will get all modes.  "all,-image  bounce,+blank"  will
1701            get  all modes excluding image and bounce modes.  "bug wator" will
1702            get only bug and wator.  "allgl" will get only  the  GL  modes  if
1703            compiled  in, all-allgl will get all excluding the GL modes, "all‐
1704            nice" will weed out high cpu usage modes (as well as  hackers  and
1705            gl  modes).  "allxpm" will get all modes that use xpm.  "allwrite"
1706            will get all modes that take advantage of writable colormaps  (not
1707            including  xpm).  "all3d" will get all the modes that support this
1708            option.  "allmouse" will get all  the  modes  that  support  mouse
1709            interaction.   Similarly,  "allautomata" for automata modes, "all‐
1710            fractal" for fractal  modes,  "allgeometry"  for  geometry  modes,
1711            "allspace"  for  space  modes.   The random mode itself can not be
1712            referenced.
1713
1714       -/+sequential
1715            Turn on non-random random option.
1716
1717

**WARNING**

1719       xlock can appear to hang  if  it  is  competing  with  a  high-priority
1720       process  for  the CPU. For example, if xlock is started after a process
1721       with 'nice -20' (high priority), xlock will take   considerable  amount
1722       of time to respond.
1723
1724

SHADOW PASSWORDS

1726       If the machine is using a shadow password system, then xlock may not be
1727       set up to get the real password and so must be given one  of  its  own.
1728       This  can be either on the command line, via the -cpasswd option, or in
1729       the file $HOME/.xlockrc, with the first  taking  precedence.   In  both
1730       cases  an  encrypted password is expected (see makekey(8)).  If neither
1731       is given, then xlock will prompt for a password and will use that, also
1732       storing an encrypted version of it in $HOME/.xlockrc for future use.
1733
1734

XLOCK AND SSH-AGENT

1736       If  you  use ssh-agent(1) to avoid entering a passphrase every time you
1737       use one of your ssh(1) private keys, it's  good  security  practice  to
1738       have  ssh-agent  forget  the  keys before you leave your terminal unat‐
1739       tended.  That way, an attacker who takes over your  terminal  won't  be
1740       able to use your private ssh keys to log in to other systems.  Once you
1741       return to your terminal, you can enter the passphrase  and  re-add  the
1742       keys  to ssh-agent.  There are a couple of ways in which xlock can help
1743       to automate this process.  Firstly, the startCmd option allows xlock to
1744       be  configured  to  run 'ssh-add -D' every time you lock the screen, so
1745       that your keys  are  automatically  deleted  from  ssh-agent.   If  the
1746       passphrase  on  your  ssh keys is the same as your password, then xlock
1747       can also be made to re-add the keys to ssh-agent when  you  unlock  the
1748       screen,  via the pipepassCmd option.  This requires a bit of scripting,
1749       as the command must read your password from  standard  input  and  then
1750       automate  the interaction with ssh-add to re-add the keys.  There is an
1751       example of such a script in the xlock distribution - see etc/xlockssh*
1752
1753

BUGS

1755       "kill -KILL xlock " causes the server that was locked to  be  unusable,
1756       since all hosts (including localhost) were removed from the access con‐
1757       trol list to lock out new X clients, and since xlock  could  not  catch
1758       SIGKILL,  it terminated before restoring the access control list.  This
1759       will leave the X server in a state where "you can no longer connect  to
1760       that server, and this operation cannot be reversed unless you reset the
1761       server."            -From the X11R4 Xlib Documentation, Chapter 7.
1762       NCD terminals do not allow xlock to  remove  all  the  hosts  from  the
1763       access  control list.  Therefore you will need to use the "-remote" and
1764       "-allowaccess" switches.  If you happen to run  without  "-allowaccess"
1765       on an NCD terminal, xlock will not work and you will need to reboot the
1766       terminal, or simply go into the SETUP  menus,  under  'Network  Parame‐
1767       ters', and turn off TCP/IP access control.
1768

SEE ALSO

1770       X(1), Xlib Documentation.
1771
1772

AUTHOR

1774       Maintained by:
1775              David A. Bagley, <bagleyd@tux.org>
1776
1777       The latest version is currently at:
1778              ftp://ftp.tux.org/pub/tux/bagleyd/xlockmore
1779              ftp://ibiblio.org/pub/Linux/X11/screensavers
1780
1781       Original Author:
1782              Patrick J. Naughton, <naughton@eng.sun.com>
1783              Mailstop 21-14
1784              Sun Microsystems Laboratories, Inc.
1785              Mountain View, CA  94043
1786              415/336-1080
1787
1788       with many additional contributors.
1789
1790
1792       Copyright (c) 1988-1991 by Patrick J. Naughton
1793       Copyright (c) 1993-2010 by David A. Bagley
1794
1795       Permission  to  use, copy, modify, and distribute this software and its
1796       documentation for any purpose and without fee is hereby  granted,  pro‐
1797       vided  that  the  above  copyright notice appear in all copies and that
1798       both that copyright notice and this permission notice  appear  in  sup‐
1799       porting documentation.
1800       The  original  BSD daemon is Copyright (c) 1988 Marshall Kirk McKusick.
1801       All Rights Reserved.
1802       DEC, HP, IBM, Linux, SCO, SGI, and  Sun  icons  have  their  respective
1803       copyrights.
1804
1805
1806
1807X11R6 Contrib                     27 Jan 2010                         XLOCK(1)
Impressum