[net.sources] DYNAKEY manual page

jchvr@ihlpg.UUCP (VanRietschote) (01/07/86)

---
manual page of dynakey program see previous news item.

-- cut here ---
.TH DYNAKEY 1 "HFVR"
.SH NAME
.\" name \- one-line description for in permuted index
dynakey \- display file status dynamically on HP2392 keys
.SH SYNOPSIS
.\" bnf on command syntax
dynakey { -w -l -L -f -b -B -s}+  [-d] [&]
.SH DESCRIPTION
.\" semantics
dynakey will watch all files mentioned in the -w option. If a file
changes (mtime(1) changes) and the size of the file is >0 then the
HP2392 function label is displayed with the text as given in the -l switch. 
If the file did not change since last dynakey looked then the text given
in the -L switch is displayed. The first time dynakey looks the files
are unchanged (expect for special files (see below)).
.sp
The label to display can be formatted with the following % escapes:
.sp
.tr ~
.in +6
.ti -6
%M~~~~will be replaced in output by modification time of file being watched
(in same format as %T).
.sp
.ti -6
%S~~~~will be replaced in output by size of file being watched (%8ld).
.sp
.ti -6
%T~~~~will be replaced in output by current time in HH:MM format
.sp
.ti -6
`cmd`~will be replaced by the first line of the output of executing "cmd".
(The trailing CR in the output is not kept).
.in -6
.sp
Dynakey will automatically stop when the parent process stops.
.SH OPTIONS
.tr ~
.in +6
.ti -6
-w~~~~Takes as argument the file to watch. Special files are:
.sp
MAIL: the file is considered changed as long as there is a mail message
waiting for you.
.sp
TIME: this file is considered to always change.
.sp
NETNEWS: this file is considered changed as long as the modification
time of your $HOME/.newsrc file is less then the $TOOLS/lib/netnews/history
file. In effect this means that you have unread netnews waiting.
.sp
.ti -6
-l~~~~Takes as argument the text to display on the label as long
as the file is changed. Default: empty. An empty label to display means
that the label contents is not changed.
.sp
.ti -6
-L~~~~Takes as argument the text to display on the label while the file
is unchanged. Default empty.
An empty label to display means
that the label contents is not changed.
.sp
.ti -6
-b~~~~If given then dynakey will beep twice if the file changes.
Default is OFF.
.sp
.ti -6
-B~~~~If given then dynakey will beep twice if label changes. (Useful
for being notified when output of label with `cmd` in it changes.
.sp
.ti -6
-f~~~~takes as argument the number of the function key whose label
is to be used for displaying. Default 1.
.sp
.ti -6
-s~~~~takes as argument the number of seconds to wait between checks
on the file changing. Each file has its own time. Default 60.
.sp
.ti -6
-d~~~~if given shows some debug output. (Eg. a full list of all watches).
.in -6
.SH EXAMPLES
.nf
dynakey -wTIME -b -s900    # beep twice every 15 min (.keepport)
dynakey -wTIME -f1 -l'%T'  # display time every minute on keylabel 1
dynakey -wMAIL -f2 -l'Mail' -L'No mail'& # display on f2 Mail if mail
                                         # else display No mail
dynakey -wNETNEWS -b -l'News    %M' # beep and display news 
        -L ' '                      # + newstime if 
                                    # netnews arrives else spaces
dynakey -w$COFFEE -b -l'Coffee'# beep if $COFFEE changes
dynakey -w$HOME/rje -b         # beep if someone changes rje dir.
dynakey -wTIME -f1 -l'%T' -s60 # display time every minute
        -wTIME -f2 -l'`who|wc -l`' -s300 #  and nr. users every 5 min
.fi
.SH "SHELL VARIABLES"
The following shell variables must be set:
.sp
.nf
HOME        # to point to login diretory
LOGNAME     # real login name of user
TOOLS       # to point to `logdir exptools'
.fi
.SH SEE ALSO
setkey(1), crontab(1)