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 ] [ -xkblockgroup
21       layout ] [ -font fontname ] [ -planfont fontname ] [ -bg color ] [  -fg
22       color  ] [ -background color ] [ -foreground color ] [ -username string
23       ] [ -password string ] [ -info string ] [ -validate string ] [ -invalid
24       string ] [ -geometry geom ] [ -icongeometry geom ] [ -glgeometry geom ]
25       [ -/+wireframe ] [ -/+showfps ] [ -fpsfont fontname ] [ -/+fpstop  ]  [
26       -/+use3d  ]  [  -delta3d value ] [ -none3d color ] [ -right3d color ] [
27       -left3d color ] [ -both3d color ] [ -program programname ] [ -messages‐
28       file formatted-filename ] [ -messagefile filename ] [ -message string ]
29       [ -messagefont fontname ] [ -bitmap filename ] [ -cpasswd crypted-pass‐
30       word ] [ -forceLogout minutes ] [ -logoutButton minutes ] [ -logoutBut‐
31       tonLabel textstring ] [ -logoutButtonHelp textstring ] [ -logoutFailed‐
32       String 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 re‐
41       fused.  The screen saver is disabled.  The mouse cursor is turned  off.
42       The  screen is blanked and a changing pattern is put on the screen.  If
43       a key or a mouse button is pressed then the user is  prompted  for  the
44       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  au‐
58       thentication styles.
59
60

NOTE ON ETIQUETTE

62       Xlock  should  not be used on public terminals when there is a high de‐
63       mand 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 de‐
112               pending 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  im‐
179               age.  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 de‐
277               pending 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  de‐
297               pending 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 an‐
701            other.  for text3d it is the number of times drawing a word before
702            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 de‐
766            rived values for remote and prevents xlock from being used to lock
767            other  X11 servers.  (Use `+' instead of `-' to override resources
768            for other options that can take the `+' modifier similarly.)
769
770       -/+mono
771            The mono option causes xlock to  display  monochrome,  (black  and
772            white)  pixels  rather than the default colored ones on color dis‐
773            plays.
774
775       -/+allowaccess
776            This option is required for servers which do not allow clients  to
777            modify  the  host  access  control list.  It is also useful if you
778            need to run x clients on a server which is locked  for  some  rea‐
779            son...   When allowaccess is true, the X11 server is left open for
780            clients to attach and thus lowers the inherent  security  of  this
781            lock  screen.  A side effect of using this option is that if xlock
782            is killed -KILL, the access control list is not lost.
783
784       -vtlock modename
785            This option is used on a XFree86 system to manage VT switching  in
786            [off|noswitch|switch|restore] mode.
787
788       off       means no VT switch locking.
789
790       switch    means  VT  switch  locking + switching to xlock VT when acti‐
791                 vated.
792
793       restore   means VT switch locking + switching to xlock  VT  when  acti‐
794                 vated + switching back to previous VT when deactivated.
795
796       noswitch  means VT switch locking only when xlock VT is active.
797
798       -/+allowroot
799            The allowroot option allows the root password to unlock the server
800            as well as the user who started xlock.  May not be  able  to  turn
801            this on and off depending on your system and how xlock was config‐
802            ured.
803
804       -/+debug
805            Allows xlock to be debugged by doing all but locking the screen.
806
807       -/+description
808            The description option causes xlock shows a mode description above
809            password window.  The default is to show this description.
810
811       -/+echokeys
812            The  echokeys option causes xlock to echo '?' characters (default)
813            for each key typed into the password prompt.  Some consider this a
814            security risk, so the default is to not echo anything.
815
816       -echokey echokey
817            The text character to use for echo key in echokeys .
818
819       -/+enablesaver
820            By  default  xlock will disable the normal X server's screen saver
821            since it is in effect a replacement for it.  Since it is  possible
822            to set delay parameters long enough to cause phosphor burn on some
823            displays, this option will turn back on the default  screen  saver
824            which is very careful to keep most of the screen black.
825
826       -/+resetsaver
827            By  default  xlock will call XResetScreenSaver.  This may be unde‐
828            sirable with DPMS monitors.
829
830       -/+grabmouse
831            The grabmouse option causes xlock to grab the mouse and  keyboard,
832            this is the default.  xlock can not lock the screen without this.
833
834       -/+grabserver
835            The  grabserver  option  causes xlock to grab the server.  This is
836            not usually needed but some unsecure X  servers  can  be  defeated
837            without this.
838
839       -/+install
840            Allows xlock to install its own colormap if xlock runs out of col‐
841            ors.  May not work on with some window managers  (fvwm)  and  does
842            not work with the -inroot option.
843
844       -/+mousemotion
845            Allows  you  to  turn  on  and off the sensitivity to the mouse to
846            bring up the password window.
847
848       -/+sound
849            Allows you to turn on and off sound if installed with the capabil‐
850            ity.
851
852       -/+showdate
853            Allows  you to turn on and off the date on password window.  On by
854            default.
855
856       -/+timeelapsed
857            Allows you to find out how long a machine is  locked  so  you  can
858            complain to an administrator that someone is hogging a machine.
859
860       -/+usefirst
861            The  usefirst  option  causes xlock to use the keystroke which got
862            you to the password screen as the first character in the password.
863            The default is to ignore the first key pressed.
864
865       -/+verbose
866            Verbose mode, tells what options it is going to use.
867
868       -nice nicelevel
869            The  nice  option  sets  system  nicelevel of the xlock process to
870            nicelevel .
871
872       -lockdelay seconds
873            The lockdelay option sets the number of seconds before the  screen
874            needs a password to be unlocked.  Good for use with an autolocking
875            mechanism like xautolock(1).
876
877       -timeout seconds
878            The timeout option sets the number of seconds before the  password
879            screen will time out.
880
881       -font fontname
882            The font option sets the font to be used on the prompt screen.
883
884       -planfont fontname
885            option  sets the font to be used for the text that is displayed in
886            the lower part of the password screen.
887
888       -fg color
889            The fg option sets the color of the text on the password screen to
890            color .
891
892       -bg color
893            The  bg  option  sets  the color of the background on the password
894            screen to color .
895
896       -foreground color
897            The foreground option sets the color of the text on  the  password
898            screen to color .
899
900       -background color
901            The  background  option  sets  the  color of the background on the
902            password screen to color .
903
904       -username string
905            Text string is shown in front of user name, defaults to "Name: ".
906
907       -password string
908            Text string is the password prompt string, defaults to  "Password:
909            ".
910
911       -info string
912            Text  string  is an informational message to tell the user what to
913            do, defaults to "Enter password to unlock; select icon to lock.".
914
915       -validate string
916            Text string is a message shown while validating the password,  de‐
917            faults to "Validating login..."
918
919       -invalid string
920            Text  string is a message shown when password is invalid, defaults
921            to "Invalid login."
922
923       -geometry geom
924            The geometry option sets geom the size and offset of the lock win‐
925            dow  (normally  the  entire  screen).  The entire screen format is
926            still used for entering the password.  The purpose is to  see  the
927            screen even though it is locked.  This should be used with caution
928            since many of the modes will fail if  the  windows  are  far  from
929            square  or  are  too  small (size must be greater than 0x0).  This
930            should also be used with -enablesaver to protect screen from phos‐
931            phor burn.
932
933       -icongeometry geom
934            The  icongeometry  option  sets geom the size of the iconic screen
935            (normally 64x64) seen when entering the password.  This should  be
936            used with caution since many of the modes will fail if the windows
937            are far from square or are too small (size must  be  greater  than
938            0x0).   The  greatest size is 256x256.  There should be some limit
939            so users could see who has locked the screen.   Position  informa‐
940            tion of icon is ignored.
941
942       -glgeometry geom
943            The  glgeometry  option  sets  geom  the size of the screen for gl
944            modes.  Not normally available or needed.
945
946       -/+wireframe
947            Turn on/off wireframe, available  on  ant3d,  atlantis,  atunnels,
948            daisy,  fire, gears, lament, life3d, mountain, sballs, sproingies,
949            superquadrics, and triangle.
950
951       -/+showfps
952            Turn on/off frame per sec display, available  on  atlantis,  atun‐
953            nels,  bubble3d,  cage,  fire,  gears,  invert,  lament,  moebius,
954            morph3d, rubik, sballs, skewb, stairs, and superquadrics.
955
956       -/+fpstop
957            Turn on/off frame per sec  display  on  top  of  screen,  used  if
958            showfps is on.
959
960       -fpsfont fontname
961            The  fpsfont  option sets the font to be used in the frame per sec
962            display, used if showfps is on.
963
964       -/+use3d
965            Turn on/off 3d view, available on bouboule, pyro, star, and worm.
966
967       -delta3d value
968            Space between the center of your 2 eyes for 3d mode.
969
970       -none3d color
971            Color used for empty size in 3d mode.
972
973       -right3d color
974            Color used for right eye in 3d mode.
975
976       -left3d color
977            Color used for left eye in 3d mode.
978
979       -both3d color
980            Color used for overlapping images for left and  right  eye  in  3d
981            mode.
982
983       -program programname
984            The program option sets the program to be used as the fortune gen‐
985            erator.  Currently used only for marquee and nose modes.
986
987       -messagesfile formatted-filename
988            The messagesfile option sets the file to be used  as  the  fortune
989            generator.   The  first  entry is the number of fortunes, the next
990            line contains the first fortune.  Fortunes begin with a "%%" on  a
991            line  by  itself.  Currently used only for marquee and nose modes.
992            If one exists, it takes precedence over the fortune program.
993
994       -messagefile filename
995            The messagefile option sets the file whose contents are displayed.
996            Currently used only for marquee and nose modes.  If one exists, it
997            takes precedence over the fortune program and messagesfile.
998
999       -message textstring
1000            The message option sets the text to be displayed in a mode.   Cur‐
1001            rently used only for flag, marquee and nose modes.  If one exists,
1002            it takes precedence over the  fortune  program,  messagesfile  and
1003            message.
1004
1005       -messagefont fontname
1006            The messagefont option sets the font to be used in the mode.  Cur‐
1007            rently used only for flag, marquee, and nose modes.
1008
1009       -bitmap filename
1010            The bitmap option sets the xbm, xpm, or ras file to  be  displayed
1011            with  flag,  image,  life, life1d, maze, or puzzle mode.  For eyes
1012            and pacman only a xbm file is accepted.  Certain modes reject  the
1013            bitmap if too big.  /
1014
1015

MORE OPTIONS (these may not be available)

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

SPECIAL MODE DEPENDENT OPTIONS

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

**WARNING**

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

SHADOW PASSWORDS

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

XLOCK AND SSH-AGENT

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

BUGS

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

SEE ALSO

1777       X(1), Xlib Documentation.
1778
1779

AUTHOR

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