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

MORE OPTIONS (these may not be available)

1018       -cpasswd crypted-password
1019            The cpasswd option sets the key to be this text string  to  unlock
1020            xlock instead of password file.
1021
1022       -forceLogout minutes
1023            The forceLogout option sets minutes to auto-logout.
1024
1025       -logoutButton minutes
1026            The  logoutButton option sets minutes to logoutButton is available
1027            on password screen.
1028
1029       -logoutButtonLabel string
1030            Text string is a message shown inside logout  button  when  logout
1031            button is displayed.  Defaults to "Logout".
1032
1033       -logoutButtonHelp string
1034            Text  string  is a message shown outside logout button when logout
1035            button is displayed.  Defaults to "Click the \"Logout\" button  to
1036            log out current\n user and make workstation available."
1037
1038       -logoutFailedString string
1039            Text  string  is  a  message  shown when a logout is attempted and
1040            fails.  Defaults to "Logout attempt FAILED.\n Current  user  could
1041            not be automatically logged out."
1042
1043       -/+dtsaver
1044            Turn  on/off CDE Saver Mode.  This option is only available if CDE
1045            support was compiled in.
1046
1047       -/+xinerama
1048            Turn on/off Xinerama.  This option is only available  if  Xinerama
1049            support was compiled in.
1050
1051       -modulepath path
1052            The modulepath option sets the directories that xlock searches for
1053            mode modules to load.  It is a colon separated list of directories
1054            to  search. If "%S" is included in the path, it is replaced by the
1055            default modulepath.  To add a  private  module  directory  to  the
1056            default  path,  use something like '%S:~/mymoduledir' as the path.
1057            This option is only available if module support was compiled in.
1058
1059       -locksound string
1060            Text string references sound to use at lock time.  Default  sound,
1061            male voice: "Thank you, for your cooperation."
1062
1063       -infosound string
1064            Text  string  references  sound  to  use for information.  Default
1065            sound, male voice: "Identify please."
1066
1067       -validsound string
1068            Text string references sound to when a password is valid.  Default
1069            sound, female voice: "Complete."
1070
1071       -invalidsound string
1072            Text  string  references  sound  to  when  a  password is invalid.
1073            Default sound, female voice: "I am not programmed to give you that
1074            information."
1075
1076       -startCmd string
1077            Text string command to execute when the screen is locked. Commonly
1078            used instructions include: "zaway". This command, if still running
1079            when the screensaver exits, will be killed.
1080
1081       -endCmd string
1082            Text string command to execute when the screen is unlocked.
1083
1084       -pipepassCmd string
1085            Text  string  command  into  which  to  pipe the password when the
1086            screen is unlocked.
1087
1088       -logoutCmd string
1089            Text string command to execute when the program logs the user  out
1090            (either via the autologout or by pressing the logout button).
1091
1092       -mailCmd string
1093            Text string command to execute when the program to check mail.
1094
1095       -mailIcon string
1096            Text string of file for the "mail arrived" bitmap.
1097
1098       -nomailIcon string
1099            Text string of file for the "no mail" bitmap.
1100
1101       -dpmsstandby  seconds
1102            Allows  one to set DPMS Standby for monitor (0 is defined as infi‐
1103            nite).  (Horizontal sync on, Vertical  sync  off,  RGB  guns  off,
1104            power  supply  on,  tube filaments energized, (screen saver mode).
1105            Typical 17 inch screen...  110 out of  120  watts  with  a  3  sec
1106            recovery time.)  This option is only available if DPMS support was
1107            compiled in.  Minimum timeout is 5 seconds.
1108
1109       -dpmssuspend  seconds
1110            Allows one to set DPMS Suspend for monitor (0 is defined as  infi‐
1111            nite).   (Horizontal  sync  off,  Vertical  sync on, RGB guns off,
1112            power supply off,  tube  filaments  energized.   Typical  17  inch
1113            screen ...  15 out of 120 watts with a 3 sec recovery time.)  This
1114            option is only available if DPMS support was compiled in.  Minimum
1115            timeout is 5 seconds.
1116
1117       -dpmsoff  seconds
1118            Allows  one  to  set  DPMS  Power Off for monitor (0 is defined as
1119            infinite).  (Horizontal sync off, Vertical sync off, Small  auxil‐
1120            iary circuit stays on to monitor the HS/VS signals to enable power
1121            on when data needs to be displayed on the screen.  Typical 17 inch
1122            screen ...  5 out of 120 watts with a 10 sec recovery time.)  This
1123            option is only available if DPMS support was compiled in.  Minimum
1124            timeout is 5 seconds.
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 B<neighborhood>/S<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   B3/S23.   Others  are  B36/S23  and
1169            B3678/S34678.  For life3d good examples are Bay's rules which  are
1170            B5/S45,  B6/S567, B5/S56, and B67/S67.  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.
1344
1345       -/+popcorn
1346            Turn on and off Clifford A. Pickover's popcorn hop.
1347
1348       -/+ejk1...ejk6
1349            Turn on and off Ed J. Kubaitis' hops.
1350
1351       -/+rr
1352            Turn on and off Renaldo Recuerdo's hop.
1353
1354       -/+jong
1355            Turn on and off Jong's hop.
1356
1357       -/+sine
1358            Turn on and off Barry Martin's sine hop.
1359
1360       -pattern <pattern>
1361            Allows one to set the pattern for juggle.
1362
1363       -tail num
1364            Minimum Trail Length for juggle.
1365
1366       -/+real
1367            Turn on/off real-time juggling  for  juggle.   Deprecated.   There
1368            should  be  no  need  to turn off real-time juggling, even on slow
1369            systems.  Adjust speed using -count.
1370
1371       -/+describe
1372            Turn on/off pattern descriptions in juggle.
1373
1374       -/+balls
1375            Turn on/off Balls in juggle.
1376
1377       -/+clubs
1378            Turn on/off Clubs in juggle.
1379
1380       -/+torches
1381            Turn on/off Flaming Torches in juggle.
1382
1383       -/+knives
1384            Turn on/off Knives in juggle.
1385
1386       -/+rings
1387            Turn on/off Rings in juggle.
1388
1389       -/+bballs
1390            Turn on/off Bowling Balls in juggle.
1391
1392       -/+planetary
1393            Turn on and off planetary gears in gears.
1394
1395       -planetsize num
1396            Sets the size of the screen for planetary option in  gears.   This
1397            is for machines with slower CPU. (Set to 0 for full screen).
1398
1399       -/+disconnected
1400            Turn on and off disconnected pen movement in kaleid.
1401
1402       -/+alternate
1403            Turn on and off alternate rotated display mode kaleid.
1404
1405       -/+quad
1406            Turn  on  and  off quad mirrored/rotated mode similar to size 4 in
1407            kaleid.
1408
1409       -/+oct
1410            Turn on and off oct mirrored/rotated mode similar  to  size  8  in
1411            kaleid.
1412
1413       -/+linear
1414            Turn on and off Cartesian/Polar coordinate mode in kaleid.
1415
1416       -/+conway
1417            Turn on and off John Conway's original Life rule B3/S23 life.
1418
1419       -/+highlife
1420            Turn on and off David Bell's HighLife rule B36/S23 life.
1421
1422       -/+daynight
1423            Turn  on and off Nathan Thompson's Day and Night rule B3678/S34678
1424            life.
1425
1426       -/+callahan
1427            Turn on and off Paul Callahan's B2o/S2m34 hexagonal life.
1428
1429       -/+andreen
1430            Turn on and off Bob Andreen's B2o3o4m/S2om4o hexagonal life.
1431
1432       -/+trilife
1433            Turn on and off Carter Bays' B45/S34 triangular life.
1434
1435       -/+trilife1
1436            Turn on and off Carter Bays' B456/S45 triangular life.
1437
1438       -/+trilife2
1439            Turn on and off Carter Bays' B45/S23 triangular life.
1440
1441       -/+totalistic
1442            Turn on and off totalistic rules for life1d.  If this is off  then
1443            it  follows  rules of the LCAU collection.  These rules may not be
1444            symmetric and are more general.
1445
1446       -/+additive
1447            Turn on and off additive functions mode in lisa.
1448
1449       -/+dissolve
1450            Turn on and off disolving state in loop.
1451
1452       -/+evolve
1453            Turn on and off Evolving Loops in loop.
1454
1455       -/+langton
1456            Turn on and off Langton Loops for loop.
1457
1458       -/+sheath
1459            Turn on and off sheath extension for loop.
1460
1461       -/+wrap
1462            Turn on and off wrapping of borders for loop.
1463
1464       -increment num
1465            Sets the option for increasing orders in mandelbrot.
1466
1467       -/+alpha
1468            Turn on and off interior displaying level  of  closest  return  in
1469            mandelbrot.
1470
1471       -/+binary
1472            Turn  on  and off binary decomposition color modulation in mandel‐
1473            brot.
1474
1475       -/+dem
1476            Turn on and off Distance Estimator Method (instead of escape time)
1477            in mandelbrot.
1478
1479       -/+index
1480            Turn on and off interior displaying iteration of closest return in
1481            mandelbrot.
1482
1483       -/+lyap
1484            Turn on and off interior displaying according to  an  estimate  of
1485            the Lyapunov exponent in mandelbrot.
1486
1487       -/+pow
1488            Turn on and off adding z^z in mandelbrot.
1489
1490       -/+sin
1491            Turn on and off adding sin(z) in mandelbrot.
1492
1493       -/+noants
1494            Turn off and on ants in moebius.
1495
1496       -/+solidmoebius
1497            Turn on and off solid Mobius strip in moebius.
1498
1499       -/+atoms
1500            Turn on and off the drawing of spheres for the atoms in molecule.
1501
1502       -/+bbox
1503            Turn on and off showing the molecules in a blue box in molecule.
1504
1505       -/+bonds
1506            Turn on and off the drawing of the atomic bonds in molecule.
1507
1508       -molecule filename
1509            Read a molecule structure from a pdb file in molecule.
1510
1511       -/+labels
1512            Turn on and off the labeling of the atoms in molecule.
1513
1514       -spin{x|y|z}
1515            Set  the  axis  for molecule rotation in molecule.  The default is
1516            "XYZ".
1517
1518       +spin
1519            Turn off the molecule rotation in molecule.
1520
1521       -/+titles
1522            Turn on and off the molecule description in molecule.
1523
1524       -/+wander
1525            Turn on and off the moving of the molecule on a  sinoid  curve  in
1526            molecule.  Turn on and off movements in fire.
1527
1528       -/+ammann
1529            Turn on and off lines for penrose.
1530
1531       -increment value
1532            Allows fine adjustments to order in mandelbrot.
1533
1534       -/+erase
1535            Turn  on and off erasing for spline.  If this option is on, cycles
1536            is divided by 64 to compute the number of lines, so as to be  com‐
1537            patible when using -fullrandom.
1538
1539       -factory num
1540            Number of extra factory parts in pipes.
1541
1542       -/+fisheye
1543            Turn on if you want a zoomed-in view of pipes.
1544
1545       -/+tightturns
1546            Turn on if you want the pipes to bend more often.
1547
1548       -/+rotatepipes
1549            Turn on if you want the pipe system rotated in pipes.
1550
1551       -/+complete
1552            Turn on or off complete graph morphing in qix.
1553
1554       -msg textstring
1555            Allows  one  to  pass  different explosion elements to pyro2.  The
1556            explosion types is one of &0, &1, ... &9, &a, ... &f each of which
1557            presents  a different type of explosion.  Normal text can be sent,
1558            the string may contain blanks if quoted.  An operation system logo
1559            will be shown, if the # sign is sent.
1560
1561       -fnt font
1562            Allows one to pass different elements to pyro2.
1563
1564       -size[xyz] num
1565            Number  represents  the  number  of cubies on the x, y, or z axis.
1566            Negative numbers offer randomness from 2 to the absolute value  of
1567            the number.  star.
1568
1569       -/+hideshuffling
1570            Turn on or off hidden shuffle phase for rubik and skewb.
1571
1572       -/+border
1573            Turn on or off borders in shape.
1574
1575       -/+shadowing
1576            Turn on or off shadowing in shape.
1577
1578       -/+stippling
1579            Turn on or off stippling in shape.
1580
1581       -intensity value
1582            Set  the brightness (default 2185) of the sierpinski structure for
1583            sierpinski3d.
1584
1585       -maxdepth value
1586            Set the maximum depth (up to 10) of the sierpinski  structure  for
1587            sierpinski3d.
1588
1589       -speed value
1590            Determines  after  how  much  steps the depth changes for sierpin‐
1591            ski3d.
1592
1593       -trek num
1594            If its a high number you will see the space ship all the  time  in
1595            star.
1596
1597       -/+rock
1598            Turn  on  and  off  rocks for star.  If this is off, stars will be
1599            seen instead.
1600
1601       -/+straight
1602            Turn on if star gets you motion sick.
1603
1604       -cyclepeed num
1605            Set speed of cycling in starfish.
1606
1607       -rotation num
1608            Set rotation velocity in starfish.
1609
1610       -thickness num
1611            Set thickness in starfish.
1612
1613       -/+rock
1614            Turn on and off blob for starfish.
1615
1616       -curve num
1617            Set the curve factor of the attractors for strange.
1618
1619       -points num
1620            Change the number of points/iterations each frame for strange.
1621
1622       -point-size num
1623            Change the size of individual points for strange.
1624
1625       -zoom float
1626            Zoom in or out for strange.
1627
1628       -brightness float
1629            Adjust the brightness for accumulator mode for strange.
1630
1631       -motion-blur float
1632            Adds motion blur for strange.
1633
1634       -spinspeed num
1635            Set speed of rotation, in degrees per frame for superquadrics.
1636
1637       -/+bonus
1638            Turn on in tetris to see 5 square bonus pieces.
1639
1640       -/+well
1641            Turn on in tetris to see welltris.
1642
1643       -ttfont filename
1644            Sets the True Type font file (or font directory) used for text3d
1645
1646       -extrusion num
1647            Sets length of the text extrusion for text3d
1648
1649       -rot_amplitude float
1650            Sets rotation amplitude value of each letter for text3d
1651
1652       -rot_frequency float
1653            Sets rotation frequency for text3d
1654
1655       -/+no_split
1656            Turn on and off word splitting for text3d
1657
1658       -ttanimate function_name
1659            Sets the animation function used for text3d.  Currently one  of  :
1660            Random    FullRandom    Default   Default2   None   Crazy   UpDown
1661             Extrude  RotateXY  RotateYZ  Frequency  Amplitude
1662
1663       -speed km/h
1664            The speed for all planes in km/h for xcl.
1665
1666       -frametime microseconds
1667            The time for one frame on the screen. This time is used to  calcu‐
1668            late  the  delay time and depends on the speed of the X server for
1669            xcl.
1670
1671       -line_length mm
1672            The distance between the pilot and the plane for xcl.
1673
1674       -spectator mm
1675            The distance between spectator and pilot. It should be grater than
1676            the  line_length  and  the  half wing width of the plane to be not
1677            dangerous for the spectator for xcl.
1678
1679       -viewmodel
1680            Shows an animated view of one model for xcl.
1681
1682       -/+oldcolor
1683            Sets the colors for the first two planes fixed to red  and  yellow
1684            in xcl.
1685
1686       -xcldebug
1687            Shows  some  additional  timing  information to make sure that the
1688            calibrate procedure goes right in xcl.
1689
1690       -automatic
1691               The auto scale for automatic fit into the window is Deactivated
1692               with this option for xcl.
1693
1694       -randomstart
1695            Use a random start point for models at startup for xcl.
1696
1697       -duration seconds
1698            Allows  one to set a duration for a mode in random.  Duration of 0
1699            is defined as infinite.
1700
1701       -/+fullrandom
1702            Turn on/off randomness options within modes in random.  Not imple‐
1703            mented for all mode options.
1704
1705       -modelist textstring
1706            Allows  one to pass a list of files to randomly display to random.
1707            "all" will get all files but blank  (and  bomb  if  compiled  in).
1708            "all,blank"  will  get all modes.  "all,-image bounce,+blank" will
1709            get all modes excluding image and bounce modes.  "bug wator"  will
1710            get  only  bug  and  wator.  "allgl" will get only the GL modes if
1711            compiled in, all-allgl will get all excluding the GL modes,  "all‐
1712            nice"  will  weed out high cpu usage modes (as well as hackers and
1713            gl modes).  "allxpm" will get all modes that use xpm.   "allwrite"
1714            will  get all modes that take advantage of writable colormaps (not
1715            including xpm).  "all3d" will get all the modes that support  this
1716            option.   "allmouse"  will  get  all  the modes that support mouse
1717            interaction.  Similarly, "allautomata" for automata  modes,  "all‐
1718            fractal"  for  fractal  modes,  "allgeometry"  for geometry modes,
1719            "allspace" for space modes.  The random mode  itself  can  not  be
1720            referenced.
1721
1722       -/+sequential
1723            Turn on non-random random option.
1724
1725

**WARNING**

1727       xlock  can  appear  to  hang  if  it  is competing with a high-priority
1728       process for the CPU. For example, if xlock is started after  a  process
1729       with  'nice  -20' (high priority), xlock will take  considerable amount
1730       of time to respond.
1731
1732

SHADOW PASSWORDS

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

XLOCK AND SSH-AGENT

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

BUGS

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

SEE ALSO

1778       X(1), Xlib Documentation.
1779
1780

AUTHOR

1782       Maintained by:
1783              David A. Bagley, <bagleyd AT verizon.net>
1784
1785       The latest version is currently at:
1786              https://www.sillycycle.com/xlock
1787              http://ibiblio.org/pub/Linux/X11/screensavers
1788
1789       Original Author:
1790              Patrick J. Naughton, <naughton AT eng.sun.com>
1791              Mailstop 21-14
1792              Sun Microsystems Laboratories, Inc.
1793              Mountain View, CA  94043
1794              415/336-1080
1795
1796       with many additional contributors.
1797
1798
1800       Copyright (c) 1988-1991 by Patrick J. Naughton
1801       Copyright (c) 1993-2019 by David A. Bagley
1802
1803       Permission to use, copy, modify, and distribute this software  and  its
1804       documentation  for  any purpose and without fee is hereby granted, pro‐
1805       vided that the above copyright notice appear in  all  copies  and  that
1806       both  that  copyright  notice and this permission notice appear in sup‐
1807       porting documentation.
1808
1809       This file is provided AS IS with no warranties of any kind.  The author
1810       shall have no liability with respect to the infringement of copyrights,
1811       trade secrets or any patents by this file or any part thereof.   In  no
1812       event will the author be liable for any lost revenue or profits or
1813        other special, indirect and consequential damages.
1814       The  original  BSD daemon is Copyright (c) 1988 Marshall Kirk McKusick.
1815       All Rights Reserved.
1816       DEC, HP, IBM, Linux, SCO, SGI, and  Sun  icons  have  their  respective
1817       copyrights.
1818
1819
1820
1821X11R6 Contrib                     04 Dec 2019                         XLOCK(1)
Impressum