appl/xnlock/xnlock.1

   1 .\" xnlock -- Dan Heller 1985 <argv@sun.com>
   2 .TH XNLOCK 1 "19 April 1990"
   3 .SH NAME
   4 xnlock \- amusing lock screen program with message for passers-by
   5 .SH SYNOPSIS
   6 .B xnlock
   7 [
   8 \fIoptions\fP
   9 ]
  10 [
  11 \fImessage\fP
  12 ]
  13 .SH DESCRIPTION
  14 .I xnlock
  15 is a program that acts as a screen saver for workstations running X11.
  16 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
  18 mess everything up.  When \fIxnlock\fP is running, a little man with
  19 a big nose and a hat runs around spewing out messages to the screen.
  20 By default, the messages are "humorous", but that depends on your
  21 sense of humor.
  22 .LP
  23 If a key or mouse button is pressed, a prompt is printed requesting the
  24 user's password.  If a RETURN is not typed within 30 seconds,
  25 the little man resumes running around.
  26 .LP
  27 Text on the command line is used as the message.  For example:
  28 .br
  29         % xnlock I\'m out to lunch for a couple of hours.
  30 .br
  31 Note the need to quote shell metacharacters.
  32 .LP
  33 In the absence of flags or text, \fIxnlock\fP displays random fortunes.
  34 .SH OPTIONS
  35 Command line options override all resource specifications.
  36 All arguments that are not associated with a command line option
  37 is taken to be message text that the little man will "say" every
  38 once in a while.  The resource \fBxnlock.text\fP may be set to
  39 a string.
  40 .TP
  41 .BI \-fn " fontname"
  42 The default font is the first 18 point font in the \fInew century schoolbook\fP
  43 family.  While larger fonts are recokmmended over smaller ones, any font
  44 in the server's font list will work.  The resource to use for this option
  45 is \fBxnlock.font\fP.
  46 .TP
  47 .BI \-filename "  filename"
  48 Take the message to be displayed from the file \fIfilename\fP.
  49 If \fIfilename\fP is not specified, \fI$HOME/.msgfile\fP is used.
  50 If the contents of the file are changed during runtime, the most recent text
  51 of the file is used (allowing the displayed message to be altered remotely).
  52 Carriage returns within the text are allowed, but tabs or other control
  53 characters are not translated and should not be used.
  54 The resource available for this option is \fBxnlock.file\fP.
  55 .TP
  56 .BI \-ar
  57 Accept root's password to unlock screen.  This option is true by
  58 default.  The reason for this is so that someone's screen may be
  59 unlocked by autorized users in case of emergency and the person
  60 running the program is still out to lunch.  The resource available
  61 for specifying this option is \fBxnlock.acceptRootPasswd\fP.
  62 .TP
  63 .BI \-noar
  64 Don't accept root's password.  This option is for paranoids who
  65 fear their peers might breakin using root's password and remove
  66 their files anyway.  Specifying this option on the command line
  67 overrides the \fBxnlock.acceptRootPasswd\fP if set to True.
  68 .TP
  69 .BI \-ip
  70 Ignore password prompt.
  71 The resource available for this option is \fBxnlock.ignorePasswd\fP.
  72 .TP
  73 .BI \-noip
  74 Don't ignore password prompt.  This is available in order to
  75 override the resource \fBignorePasswd\fP if set to True.
  76 .TP
  77 .BI -fg " color"
  78 Specifies the foreground color.  The resource available for this
  79 is \fBxnlock.foreground\fP.
  80 .TP
  81 .BI -bg " color"
  82 Specifies the background color.  The resource available for this
  83 is \fBxnlock.background\fP.
  84 .TP
  85 .BI \-rv
  86 Reverse the foreground and background colors.
  87 The resource for this is \fBxvnlock.reverseVideo\fP.
  88 .TP
  89 .BI \-norv
  90 Don't use reverse video.  This is available to override the reverseVideo
  91 resource if set to True.
  92 .TP
  93 .BI \-prog " program"
  94 Receive message text from the running program \fIprogram\fP. If there
  95 are arguments to \fIprogram\fP, encase them with the name of the program in
  96 quotes (e.g. xnlock -t "fortune -o").
  97 The resource for this is \fBxnlock.program\fP.
  98 .SH RESOURCES
  99 .br
 100 xnlock.font:               fontname
 101 .br
 102 xnlock.foreground:         color
 103 .br
 104 xnlock.background:         color
 105 .br
 106 xnlock.reverseVideo:       True/False
 107 .br
 108 xnlock.text:               Some random text string
 109 .br
 110 xnlock.program:            program [args]
 111 .br
 112 xnlock.ignorePasswd:       True/False
 113 .br
 114 xnlock.acceptRootPasswd:   True/False
 115 .SH FILES
 116 \fIxnlock\fP               executable file
 117 .br
 118 ~/.msgfile                 default message file
 119 .SH AUTHOR
 120 Dan Heller <argv@sun.com>  Copyright (c) 1985, 1990.
 121 .br
 122 The original version of this program was written using pixrects on
 123 a Sun 2 running SunOS 1.1.