Merge from vendor branch GCC:
[dragonfly.git] / crypto / heimdal-0.6.3 / appl / xnlock / xnlock.cat1
1
2
3
4 XNLOCK(1L)                                                         XNLOCK(1L)
5
6
7
8 NAME
9   xnlock - amusing lock screen program with message for passers-by
10
11 SYNOPSIS
12   x\bxn\bnl\blo\boc\bck\bk [ _\bo_\bp_\bt_\bi_\bo_\bn_\bs ] [ _\bm_\be_\bs_\bs_\ba_\bg_\be ]
13
14 DESCRIPTION
15   _\bx_\bn_\bl_\bo_\bc_\bk is a program that acts as a screen saver for workstations running
16   X11.  It also "locks" the screen such that the workstation can be left
17   unattended without worry that someone else will walk up to it and mess
18   everything up.  When _\bx_\bn_\bl_\bo_\bc_\bk is running, a little man with a big nose and a
19   hat runs around spewing out messages to the screen.  By default, the mes-
20   sages are "humorous", but that depends on your sense of humor.
21
22   If a key or mouse button is pressed, a prompt is printed requesting the
23   user's password.  If a RETURN is not typed within 30 seconds, the little
24   man resumes running around.
25
26   Text on the command line is used as the message.  For example:
27           % xnlock I'm out to lunch for a couple of hours.
28   Note the need to quote shell metacharacters.
29
30   In the absence of flags or text, _\bx_\bn_\bl_\bo_\bc_\bk displays random fortunes.
31
32 OPTIONS
33   Command line options override all resource specifications.  All arguments
34   that are not associated with a command line option is taken to be message
35   text that the little man will "say" every once in a while.  The resource
36   x\bxn\bnl\blo\boc\bck\bk.\b.t\bte\bex\bxt\bt may be set to a string.
37
38   -\b-f\bfn\bn _\bf_\bo_\bn_\bt_\bn_\ba_\bm_\be
39        The default font is the first 18 point font in the _\bn_\be_\bw _\bc_\be_\bn_\bt_\bu_\br_\by _\bs_\bc_\bh_\bo_\bo_\bl_\b-
40        _\bb_\bo_\bo_\bk family.  While larger fonts are recokmmended over smaller ones,
41        any font in the server's font list will work.  The resource to use for
42        this option is x\bxn\bnl\blo\boc\bck\bk.\b.f\bfo\bon\bnt\bt.
43
44   -\b-f\bfi\bil\ble\ben\bna\bam\bme\be  _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
45        Take the message to be displayed from the file _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be.  If _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
46        is not specified, _\b$_\bH_\bO_\bM_\bE_\b/_\b._\bm_\bs_\bg_\bf_\bi_\bl_\be is used.  If the contents of the file
47        are changed during runtime, the most recent text of the file is used
48        (allowing the displayed message to be altered remotely).  Carriage
49        returns within the text are allowed, but tabs or other control charac-
50        ters are not translated and should not be used.  The resource avail-
51        able for this option is x\bxn\bnl\blo\boc\bck\bk.\b.f\bfi\bil\ble\be.
52
53   -\b-a\bar\br  Accept root's password to unlock screen.  This option is true by
54        default.  The reason for this is so that someone's screen may be
55        unlocked by autorized users in case of emergency and the person run-
56        ning the program is still out to lunch.  The resource available for
57        specifying this option is x\bxn\bnl\blo\boc\bck\bk.\b.a\bac\bcc\bce\bep\bpt\btR\bRo\boo\bot\btP\bPa\bas\bss\bsw\bwd\bd.
58
59   -\b-n\bno\boa\bar\br
60        Don't accept root's password.  This option is for paranoids who fear
61        their peers might breakin using root's password and remove their files
62        anyway.  Specifying this option on the command line overrides the
63        x\bxn\bnl\blo\boc\bck\bk.\b.a\bac\bcc\bce\bep\bpt\btR\bRo\boo\bot\btP\bPa\bas\bss\bsw\bwd\bd if set to True.
64
65   -\b-i\bip\bp  Ignore password prompt.  The resource available for this option is
66        x\bxn\bnl\blo\boc\bck\bk.\b.i\big\bgn\bno\bor\bre\beP\bPa\bas\bss\bsw\bwd\bd.
67
68   -\b-n\bno\boi\bip\bp
69        Don't ignore password prompt.  This is available in order to override
70        the resource i\big\bgn\bno\bor\bre\beP\bPa\bas\bss\bsw\bwd\bd if set to True.
71
72   -\b-f\bfg\bg _\bc_\bo_\bl_\bo_\br
73        Specifies the foreground color.  The resource available for this is
74        x\bxn\bnl\blo\boc\bck\bk.\b.f\bfo\bor\bre\beg\bgr\bro\bou\bun\bnd\bd.
75
76   -\b-b\bbg\bg _\bc_\bo_\bl_\bo_\br
77        Specifies the background color.  The resource available for this is
78        x\bxn\bnl\blo\boc\bck\bk.\b.b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd.
79
80   -\b-r\brv\bv  Reverse the foreground and background colors.  The resource for this
81        is x\bxv\bvn\bnl\blo\boc\bck\bk.\b.r\bre\bev\bve\ber\brs\bse\beV\bVi\bid\bde\beo\bo.
82
83   -\b-n\bno\bor\brv\bv
84        Don't use reverse video.  This is available to override the reverseV-
85        ideo resource if set to True.
86
87   -\b-p\bpr\bro\bog\bg _\bp_\br_\bo_\bg_\br_\ba_\bm
88        Receive message text from the running program _\bp_\br_\bo_\bg_\br_\ba_\bm. If there are
89        arguments to _\bp_\br_\bo_\bg_\br_\ba_\bm, encase them with the name of the program in
90        quotes (e.g. xnlock -t "fortune -o").  The resource for this is
91        x\bxn\bnl\blo\boc\bck\bk.\b.p\bpr\bro\bog\bgr\bra\bam\bm.
92
93 RESOURCES
94   xnlock.font:               fontname
95   xnlock.foreground:         color
96   xnlock.background:         color
97   xnlock.reverseVideo:       True/False
98   xnlock.text:               Some random text string
99   xnlock.program:            program [args]
100   xnlock.ignorePasswd:       True/False
101   xnlock.acceptRootPasswd:   True/False
102
103 FILES
104   _\bx_\bn_\bl_\bo_\bc_\bk               executable file
105   ~/.msgfile                 default message file
106
107 AUTHOR
108   Dan Heller <argv@sun.com>  Copyright (c) 1985, 1990.
109   The original version of this program was written using pixrects on a Sun 2
110   running SunOS 1.1.
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132