NetNews Usenet Archive 1992 #20/NN_1992_20.iso/spool/comp/sources/unix/269

Text File | 1992-09-08 | 45.1 KB | 1,544 lines

Newsgroups: comp.sources.unix
Path: sparky!uunet!decwrl!deccrl!news.crl.dec.com!pa.dec.com!vixie
From: [e-mail] (Peter Klingebiel)
Subject: v26i070: utree - screen oriented filesystem utility (V3.03b-um), Part07/08
Message-ID: <[e-mail]>
Originator: [e-mail]
Sender: [e-mail]
Organization: DEC Palo Alto
Date: Mon, 7 Sep 92 21:49:55 GMT
Approved: [e-mail]
Lines: 1531

Submitted-By: [e-mail] (Peter Klingebiel)
Posting-Number: Volume 26, Issue 70
Archive-Name: utree/part07

#! /bin/sh
# This is a shell archive.  Remove anything before this line, then unpack
# it by saving it into a file and typing "sh file".  To overwrite existing
# files, type "sh file -c".  You can also feed this as standard input via
# unshar, or by typing "sh <file", e.g..  If this archive is complete, you
# will see the following message at the end:
#        "End of archive 7 (of 8)."
# Contents:  doc/utree.1
# Wrapped by [e-mail] on Mon Sep  7 14:39:57 1992
PATH=/bin:/usr/bin:/usr/ucb ; export PATH
if test -f 'doc/utree.1' -a "${1}" != "-c" ; then
  echo shar: Will not clobber existing file \"'doc/utree.1'\"
else
echo shar: Extracting \"'doc/utree.1'\" \(43554 characters\)
sed "s/^X//" >'doc/utree.1' <<'END_OF_FILE'
X'''\"
X'''\"   utree.man, utree 3.03-um manual page
X'''\"   klin, Fri Mar  6 11:31:02 1992
X'''\"
X'''\"   [x]roff -man utree.man
X'''\"   groff   -man [-Tdevice] utree.man
X'''\"
X'''\"   SCCSID = @(#) utree.man 3.03-um Mar  6 1992
X'''\"
X.TH UTREE 1L "UTREE Version 3.03-um" "March 6 1992"
X.SH NAME
X.LP
X\fButree\fR \- Screen oriented filesystem browser and utility
X.SH SYNOPSIS
X.LP
utree [options] [rootdirectory]
X.SH DESCRIPTION
X.LP
The screen oriented filesystem browser and utility
X\fButree\fR descends the directory hierarchy
rooted in your home directory,
defined in a tree list file if given,
or rooted in \fBrootdirectory\fR if given,
and displays the directory tree on the so called \fItree screen\fR.
On the \fItree screen\fR \fButree\fR lets you walk thru the tree,
execute some default and user defined commands on it
and change to any directory in the tree.
X.br
If you have changed to a directory \fButree\fR displays all files
in this directory on the so called \fIfile screen\fR.
On the \fIfile screen\fR \fButree\fR lets you walk thru the file list
and execute some default and user defined commands on files.
X.SH OPTIONS
X.LP
The following command line options are interpreted by \fButree\fR:
X.sp
X.TP 16
X\fB-L\fR
XFollow symbolic links to directories
X.TP
X\fB-S\fR
Ignore default minimal screen size of 80 columns and 24 lines
X.TP
X\fB-V\fR
Display \fButree\fR version and copyright notice
X.TP
X\fB-a\fR
Read in all directories,
including those that begin with a dot (.),
which are normally skipped
X.TP
X\fB-b\fR
Suppress ringing of the bell (useful for visual bells)
X.TP
X\fB-c\fR
Don't display and update a clock every second
X.TP
X\fB-d var=[val]\fR
Set the variable \fBvar\fR to value \fBval\fR
or unset the variable \fBvar\fR
X.TP
X\fB-d typ:[cmd]\fR
Define the command \fBcmd\fR for the filetype \fBtyp\fR
or undefine any command for the filetype \fBtyp\fR
X.TP
X\fB-f lst\fR
Build directory tree from list file \fBlst\fR
X.TP
X\fB-g\fR
Don't use graphical characters
X.TP
X\fB-h\fR
Display usage and some help about options
X.TP
X\fB-i ind\fR
Set the tree level indention to \fBind\fR columns (3..9)
X.TP
X\fB-n\fR
Avoid scanning the tree for changes i.e. after shell escape
X.TP
X\fB-l lev\fR
Build the tree up to level \fBlev\fR for quicker startup
X.TP
X\fB-o\fR
Omit saving changes in variables and filetype command definitions,
command history and key bindings
X.TP
X\fB-p lin\fR
Use \fBlin\fR lines for displaying filenames of the current directory
on the \fItree screen\fR (default: 3)
X.TP
X\fB-q\fR
Build the tree up to level 2 (like -l 2)
X.TP
X\fB-r\fR
Build the tree scanning and reading the file system
instead of reading a tree list file
X.TP
X\fB-s\fR
Don't use hardware scrolling
X.TP
X\fB-u\fR
Read and update all file lists after building
the tree from a tree list file
X.TP
X\fB-v mod\fR
Set using video attributes to mode \fBmod\fR.
X\fBmod\fR may be \fB2\fR for all possible,
X\fB1\fR for bold and underline
and \fB0\fR for none video attributes.
X.TP
X\fB-w\fR
Suppress warnings about unreadable directories
X.TP
X\fB-x cmd\fR
Use and execute the string \fBcmd\fR as initial input at startup.
The string \fBcmd\fR is a simple sequence of \fButree\fR commands
X.PP
The boolean options \fBbcgnosw\fR and the
numerical options \fBipv\fR may also be pre-set in
the environment variable \fBUTREE\fR.
XE.g. if you want to suppress ringing of the bell and
displaying and updating the clock and if you prefer a tree indention
of 4 columns set the environment variable \fBUTREE\fR to '\fBbci4\fR'
for this reason.
X.br
Most of the options correspond to \fButree\fR
variables and therefore they may also be set or unset
with the variable command (\fB=\fR).
See the sections \fIglobal commands\fR and \fIvariables\fR below.
X.SH UTREE STARTUP
X.LP
If \fButree\fR is called without the optional command line parameter
X\fBrootdirectory\fR or this directory is rooted in your
home directory \fButree\fR tries to build up the directory tree
reading a file \fB.utreelist\fR in your home directory,
which contains a list of your directory tree created
by a previous \fButree\fR session
or by the additional shell script \fButree.mklist\fR called before.
If the command line option \fB-f lst\fR is given
X\fButree\fR builds up the tree from this list file \fBlst\fR
which may be created with the denoted shell script \fButree.mklist\fR
or a command like \fBfind\fR.
XEntries in such list files have to start with the
directory separator / (slash) in the first column of the line.
All other entries are ignored and skipped.
X.sp
If building the tree from a list file
the file lists of directories are created and read in on demand only,
which means when a directory becomes the current directory
by moving the cursor to this directory.
This speeds up the start of \fButree\fR because there is no need
for scanning and reading the filesystem for subdirectories
what may take some time for larger filesystems.
X.sp
In all others cases,
if no list file is given with the
command line option \fB-f lst\fR,
X\fBrootdirectory\fR is rooted in your home directory
and the file \fB.utreelist\fR is not found,
or the command line option \fB-r\fR is given
X\fButree\fR builds up the tree by
scanning and reading the filesystem recursively.
You can speed up the start with the commandline option
X\fB-l lev\fR which causes \fButree\fR to build the
initial directory tree only up to level \fBlev\fR similar to
the option \fB-l\fR of the well known \fBfind\fR command.
At runtime some commands let you expand the directory
tree later and inspect directories and subtrees
not visible at startup (see below).
X.SH SCREEN LAYOUT
X.LP
The screen is divided into three regions.
The top screen line,
the so called \fIecho line\fR is for displaying
messages and entering input.
The second screen line,
the so called \fIhelp line\fR is for displaying
help messages and the \fButree\fR default
or user defined menu lines.
X.br
The rest of the screen forms a window on the directory tree
on the \fItree screen\fR or
on the file list of the current directory
on the \fIfile screen\fR.
Or he is used for displaying variable or filetype commands settings,
for displaying help pages and displaying command outputs.
X.SH UTREE SCREENS AND MENUS
X.LP
X\fBUtree\fR knows the following screens and menus:
X.sp
X.TP 20
X\fBtree screen\fR
This is the initial screen displayed when \fButree\fR is started
and has built up the directory tree.
The \fItree screen\fR forms a window on the directory tree.
The current directory on which most commands are
working is highlighted and the last
screen lines are used to display the first files
of the file list of the current directory.
You may move the window over the directory tree,
enlarge or shrink the directory tree window
or walk thru the directory tree and execute
default and user defined commands on directories and subtrees.
On the help line the most important commands available
for directories or subtrees on
the \fItree screen\fR are shown in the default \fItree menu\fR.
The tree menu shows the names of the
the \fItree screen\fR commands,
the keystrokes to invoke a command are marked with uppercase letters.
You may switch the menu to a user defined menu line
displaying user defined commands for the \fItree screen\fR.
XFor further information about all \fItree screen\fR commands
see the sections \fIglobal commands\fR,
X\fItree screen commands\fR and \fIvariables\fR of this manual page.
X.sp
X.TP
X\fBfile screen\fR
The \fIfile screen\fR forms a window on all files of the
current directory.
The current file on which most commands are
working is highlighted.
Yoy may move the window over the file list
or walk thru the file list and execute
default and user defined commands on files.
On the help line the most important commands
for files available on
the \fIfile screen\fR are shown in the default \fIfile menu\fR.
The file menu displays the names of the
the \fIfile screen\fR commands,
the keystrokes to invoke a command are marked with uppercase letters.
You may switch the menu to a user define menu line
displaying user defined commands for the \fIfile screen\fR.
XFor further information about all \fIfile screen\fR commands
see the sections \fIglobal commands\fR,
X\fIfile screen commands\fR and \fIvariables\fR of this manual page.
X.sp
X.TP
X\fBhelp screen\fR
If you have switched to the \fIhelp screen\fR with
the help command (\fBh\fR)
on the help line the
X\fIhelp menu\fR is displayed and you may
select help about interesting topics.
The help menu displays the names of all
available help topics,
the keystrokes to select help about a topic
are marked with uppercase letters.
XFor more information see the section \fIhelp pages\fR below.
X.sp
X.TP
X\fBvariables screen\fR
If you have switched to the \fIvariables\fR screen with
the variables command (\fB=\fR)
all variables and their settings are displayed
and you may set or unset any of the variables.
On the help line is shown how to set or unset a variable
in a short form.
All changes in variables definitions are
saved to the file \fB.utree\fR in your home directory
if the variable \fBAUTOSAVE\fR is set.
XFor more information see the section \fIvariables\fR below.
X.sp
X.TP
X\fBcommands screen\fR
If you have switched to the filetype \fIcommands screen\fR with
the filetype commands command (\fB:\fR)
all filetype commands and their settings are displayed
and you may set or unset any of the filetype commands.
On the help line is shown how to set or
unset a filetype command in a short form.
All changes in filetype command definitions are
saved to the file \fB.utree\fR in your home directory
if the variable \fBAUTOSAVE\fR is set.
XFor more information see the section \fIfiletype commands\fR below.
X.sp
X.TP
X\fBshell screen\fR
If you have switched to the \fIshell screen\fR with
the shell command (\fB!\fR) for executing commands
not supported directly by \fButree\fR
all previously entered commands saved in a so called
history list are displayed on the \fIshell screen\fR.
You may get any command from the history list
into the line editor for editing and execution
or enter and execute a new command.
All commands up to a maximal number defined in
the variable \fBHISTSIZE\fR are saved in the
history list.
Before leaving \fButree\fR all saved commands
in the history list are saved to a
history file \fB.utreehist\fR in your home directory
if the variable \fBAUTOSAVE\fR is set.
At startup this file is searched for and read in
if found.
XFor more information see also the section \fIvariables\fR below.
X.sp
X.TP
X\fBbindings screen\fR
If you have switched to the \fIbindings screen\fR
with the bindings command (\fB|\fR) all
currently defined key bindings and their meaning are
displayed and you may bind any key to an appropriate
utree command or to insert a string into the
input buffer.
At startup a file \fB.utree-TERM\fR in your home directory
or a file \fButree-TERM\fR in a global startup directory
is read in if found containing key bindings for
the terminal type defined in the environment variable \fBTERM\fR.
All changes in key bindings you have done on the
X\fIbindings screen\fR at runtime are saved to \fB.utree-TERM\fR
if the variable \fBAUTOSAVE\fR is set.
XFor more information see also the section \fBkey bindings\fR
below.
X.sp
X.TP
X\fBstatus screen\fR
The status command (\fBs\fR) displays all information
available about a file or directory on the \fIstatus screen\fR.
Here you may change the ownership, group membership
or access rights of a file or directory.
On BSD systems not all of the denoted changes may be allowed
for normal users.
X.SH KEY NAMING CONVENTIONS AND DEFAULT KEY BINDINGS
X.LP
All \fButree\fR commands are simple single letter commands or
control sequences.
The default or user defined commands therefore
are invoked with a single keystroke or a combination
of the <\fICONTROL\fR> key with
another key.
The naming conventions in the following manual sections
for \fButree\fR commands invoked by a keystroke are:
X.sp
X.TP  20
X\fBkey\fR
means hit this <\fIkey\fR> only
X.TP
X\fBC-key\fR
means hold down the <\fICONTROL\fR>-key and hit <\fIkey\fR>
X.PP
To permit rebinding of pre-defined keys or
binding functions keys to \fButree\fR commands
all control sequences have special names.
All key or functions names and their default bindings
are list in the table below
X.TP 20
X\fBSELECT\fR
CR, NL
X.TP
X\fBFORWARD\fR
C-f
X.TP
X\fBBACKWARD\fR
C-b
X.TP
X\fBNEXT\fR
C-n
X.TP
X\fBPREVIOUS\fR
C-p
X.TP
X\fBNEXTPAGE\fR
C-v
X.TP
X\fBPREVPAGE\fR
C-w
X.TP
X\fBBEGIN\fR
C-a
X.TP
X\fBEND\fR
C-e
X.TP
X\fBUP\fR
C-u
X.TP
X\fBDOWN\fR
C-d
X.TP
X\fBINSERT\fR
C-o
X.TP
X\fBDELETE\fR
BS
X.TP
X\fBKILL\fR
C-k
X.TP
X\fBSETMARK\fR
C-@
X.TP
X\fBGOTOMARK\fR
C-g
X.TP
X\fBGOTOTAG\fR
C-t,TAB
X.TP
X\fBHELP\fR
C-r
X.TP
X\fBREFRESH\fR
C-l
X.TP
X\fBCANCEL\fR
C-x
X.TP
X\fBBREAK\fR
C-c,C-y
X.TP
X\fBEXIT\fR
C-z
X.PP
In the following sections of this manual page the
default key bindings are used instead of the
names or functions.
X.PP
Some function keys are supported by \fButree\fR,
i.e. the four arrow or cursor keys,
and are bound to appropriate functions.
See the sections \fIkey bindings\fR and \fIfunction keys\fR
below for more details.
X.SH HELP PAGES
X.LP
If the \fButree\fR help pages contained in the file \fButree.help\fR
are accessible in a directory defined at compile time or defined in
the environment variable \fBUTLIB\fR you can get help
on all screens or from within the line editor
with the help command (\fBh\fR or \fB?\fR) or the help key (\fBC-r\fR).
After displaying help about your current context,
i.e. help about tree commands if you are on the \fItree screen\fR,
you can switch to the help menu and
select help about all topics with a single keystroke.
All \fIhelp screen\fR commmands and the menu items of the help menu
displayed on the help line are:
X.sp
X.TP 16
X\fBh\fR
X(Help) About the help pages and the help menu
X.TP
X\fBa\fR
X(About) Information about \fButree\fR and key naming conventions
X.TP
X\fBu\fR
X(Usage) Description of \fButree\fR usage and commandline options
X.TP
X\fBg\fR
X(Global) Global commands common for the \fItree\fR and the \fIfile screen\fR
X.TP
X\fBt\fR
X(Tree) Commands for the \fItree screen\fR
X.TP
X\fBf\fR
X(File) Commands for the \fIfile screen\fR
X.TP
X\fBe\fR
X(Edit) Commands of the builtin line editor
X.TP
X\fBv\fR
X(Vars) \fBUtree\fR variables and variable definition
X.TP
X\fBc\fR
X(Cmds) Filetype commands and filetype command definition
X.TP
X\fBl\fR
X(Line) Line format for user defined tree, file and filetype commands.
X.TP
X\fBk\fR
X(Keys) Function keys used by \fButree\fR
X.TP
X\fBp\fR
X(Patterns) File pattern matching, filename, modification time and
file size patterns
X.TP
X\fBq\fR
X(Quit)
Leave \fIhelp screen\fR
X.PP
The help pages contain in short form most information given
in the sections of this manual page.
X.SH GLOBAL COMMANDS
X.LP
The following commands are common for the \fItree\fR and \fIfile screen\fR
They can be given in lowercase or uppercase letters:
X.sp
X.TP 20
X\fBC-z\fR
XExit \fButree\fR from all screens
X.TP
X\fBC-c,C-y\fR
Cancel or break current command or input
X.TP
X\fBC-l\fR
Redisplay the current screen or the input line
X.TP
X\fBTAB,C-t\fR
Move to the next tagged file or the next directory
containing tagged files
X.TP
X\fBh,?,C-r\fR
Display help pages and switch to the \fIhelp screen\fR
and the help menu
X.TP
X\fB@,C-@\fR
Mark the current directory or file
X.TP
X\fB#,C-g\fR
Goto to a previously marked directory or file
X.TP
X\fBa\fR
Display \fButree\fR version and copyright notice
X.TP
X\fBd\fR
Display current date and time
X.TP
X\fBj\fR
Move to the next directory or file (for vi fans)
X.TP
X\fBk\fR
Move to the previous directory or file (for vi fans)
X.TP
X\fBn\fR
Change sort criteria from lexical order to modification time order
or vice versa and resort files in the file list
X.TP
X\fBt\fR
Tag files matching a file pattern for further processing
X.TP
X\fBu\fR
Untag files
X.TP
X\fBw\fR
Display full pathname of the current directory
X.TP
X\fBz\fR
Zoom files from filelist matching a file pattern
X.TP
X\fB=\fR
Switch to the \fIvariables screen\fR,
display and set or unset variables
X.TP
X\fB:\fR
Switch to the \fIcommands screen\fR,
display and set or unset
filetype commands
X.TP
X\fB|\fR
Switch to the \fIbindings screen\fR,
display all key bindings
and bind or rebind keys
X.TP
X\fB!\fR
Switch to the \fIshell screen\fR, display all commands
from the shell command history list, enter and execute
commands not supported directly from \fButree\fR.
Before a given command is executed the command line
is searched for some sprintf like format characters
lead in by a percent sign (%) which are expanded.
See the section \fIline formats\fR for more
information
X.TP
X\fB$\fR
XEscape to an interactive shell
X.SH TREE SCREEN COMMANDS
X.LP
All commands on the \fItree screen\fR can be given in
lowercase or uppercase letters with the meaning denoted below.
Commands given in lowercase letters affect the current directory only.
Commands given in uppercase letters
indicated by an uppercase letter in the table below
affect the subtree rooted in the current directory
or all tagged files in the subtree rooted in the current directory.
The \fItree screen\fR commmands and the menu items of the
default tree menu displayed on the help line are:
X.sp
X.TP 20
X\fB>,CR,NL,SP,>\fR
Change to the \fIfile screen\fR of the current directory
X.TP
X\fB<\fR
Change to the \fIfile screen\fR of the parent directory
X.TP
X\fBC-n\fR
Move to the next directory
X.TP
X\fBC-p\fR
Move to the previous directory
X.TP
X\fBC-f\fR
Move to the next directory on same level as the current directory
X.TP
X\fBC-b\fR
Move to the previous directory on same level as the current directory
X.TP
X\fBC-v\fR
Move one page forward
X.TP
X\fBC-w\fR
Move one page backward
X.TP
X\fBC-a\fR
Move to the beginning of the directory tree
X.TP
X\fBC-e\fR
Move to the end of the directory tree
X.TP
X\fBTAB,C-t\fR
Move to next the directory containing tagged files
X.TP
X\fBC-u\fR
Scroll up one line the directory tree
X.TP
X\fBC-d\fR
Scroll down one line the directory tree
X.TP
X\fB@,C-@\fR
Mark the current directory
X.TP
X\fB#,C-g\fR
Move to a previously marked directory
X.TP
X\fBh,?\fR
X(Help) Help about \fItree screen\fR commands
X.TP
X\fBb,B\fR
X(Backup) Backup the current directory or tree or
backup all tagged files in the subtree
X.TP
X\fBc,C\fR
X(Chdir) Move to a directory or copy all tagged files
in the subtree. Before you move to a directory you are requested
for the name of this directory before.
Instead entering a name you can select a directory
from the tree with C-n and C-p.
Instead of entering a name of a directory
where to copy the tagged files you can
select a directory from the tree with C-n and C-p
or directly from \fItree screen\fR using CR.
X.TP
X\fBf,F\fR
X(Find) Find files in the current directory or subtree matching a
file pattern you have to enter before.
If a file matching the given pattern is found
you may tag this file,
change to the directory containing the found file
or continue find
X.TP
X\fBg,G\fR
X(Grep) Search for pattern in files in the current directory or subtree.
You are requested for a file and a search pattern.
If a file matching the search pattern is found
you may tag this file,
change to the directory containing the found file
or continue search
X.TP
X\fBi\fR
X(Info) Display some short information about the current directory.
Displayed are access rights, modification time and
the disk usage of the current directory or subtree
X.TP
X\fBl,L\fR
X(List) List files in the current directory or subtree matching a file pattern
you are requested before or list all tagged files in the subtree
X.TP
X\fBm,M\fR
X(Mkdir) Create a new directory rooted in the current directory
or move all tagged files to a destination directory.
Instead of entering the directory name you can select
this name from the directory tree with C-n and C-p
or directly from \fItree screen\fR using CR.
X.TP
X\fBn,N\fR
Change the sort criteria from lexical order to modification time order
or vice versa and resort the file list of the current directory
or subtree
X.TP
X\fBo\fR
X(Out) Write a list of directories, files, tagged files,
files matching a file pattern or a formatted tree list to a list file.
A formatted tree list file can later be displayed on the screen
or send to a printer using the additional filter command
X\fButree.prlist\fR
X.TP
X\fBq\fR
X(Quit) Leave the \fItree screen\fR and exit \fButree\fR
X.TP
X\fBr,R\fR
X(Rmdir) Remove the current directory or all tagged files in
the subtree.
A directory to be removed may not
contain any subdirectories.
X.TP
X\fBs\fR
X(Stat) Switch to the \fIstatus screen\fR,
display all status information of the current directory
and change owner, group and access rights of the current directory
X.TP
X\fBt,T\fR
X(Tag) Tag files in the current directory or subtree matching a file pattern
you are requested before
X.TP
X\fBu,U\fR
X(Untag) Untag files in the current directory or subtree
X.TP
X\fBz,Z\fR
Zoom files matching a file pattern in the
current directory or subtree.
Zooming means that only those files mating the file pattern
are displayed and visible for further processing.
X.TP
X\fB+\fR
XEnlarge the tree window, shrink the file window one line
X.TP
X\fB-\fR
Shrink the tree window, enlage the file window one line
X.TP
X\fB/\fR
Scan the current directory or tree and rebuild directories
if they need rebuilding
X(i.e. if they are not yet read in or have changed)
X.TP
X\fB\e\fR
Scan the current directory for subdirectories
and build up and insert the subtree into the directory tree.
You are requested for the maximal tree level to build up
before
X.TP
X\fB0\fR
Switch the tree menuline from the default to the user defined
tree commands or vice versa
X.TP
X\fB1..9\fR
XExecute the user defined tree command 1 .. 9
X.PP
XFor further information about file patterns for the commands find,
grep, list, tag and untag see the section \fIfile patterns\fR below.
XFor user defined tree commands see the section \fIvariables\fR.
X.SH FILE SCREEN COMMANDS
X.LP
All commands on the \fIfile screen\fR can be given in lowercase
or uppercase letters with the meaning denoted below.
Commands given in lowercase letters  affect the current file only.
Commands given in uppercase letters indicated by an uppercase letter
in the table below affect
all tagged (selected) files if files are tagged or the current
file if no files are tagged.
The file \fIscreen commmands\fR and the menu items of the
default file menu displayed on the help line are:
X.sp
X.TP 20
X\fBq,CR,NL,SP\fR
X(Quit) Leave the \fIfile screen\fR and change back to the \fItree screen\fR
X.TP
X\fBC-f\fR
Move to the next file
X.TP
X\fBC-b\fR
Move to the previous file
X.TP
X\fBC-n\fR
Move to the file on the next line
X.TP
X\fBC-p\fR
Move to the file on the previous line
X.TP
X\fBC-v\fR
Move one page forward
X.TP
X\fBC-w\fR
Move one page backward
X.TP
X\fBC-a\fR
Move to the beginning of the file list
X.TP
X\fBC-e\fR
Move to the end of the file list
X.TP
X\fBTAB,C-t\fR
Move to the next tagged file
X.TP
X\fBC-u\fR
Scroll up one line the \fIfile screen\fR
X.TP
X\fBC-d\fR
Scroll down one line the \fIfile screen\fR
X.TP
X\fB@,C-@\fR
Mark the current file
X.TP
X\fB#,C-g\fR
Move to a previously marked file
X.TP
X\fBh,?\fR
X(Help) Help about \fIfile screen\fR commands and
switch to the \fIhelp screen\fR
X.TP
X\fBc,C\fR
X(Copy) Copy the current file or tagged files.
You are requested for a destination file or directory
where to copy the file or tagged files.
Instead of entering a directory name you can select
a destination directory using C-n and C-p or
select directly on the \fItree screen\fR with CR
X.TP
X\fBe,E\fR
X(Edit) Edit the current file or tagged files
X.TP
X\fBf\fR
X(Find) Find files matching a file pattern you are requested before
X.TP
X\fBg,G\fR
X(Grep) Search for a pattern in the current file or tagged files.
Before search you are requested for a file pattern and the
search pattern to search for
X.TP
X\fBi,I\fR
Display some short information about the current file or tagged files.
Displayed are the access rights, the size and the
modification time of the current file or tagged files
X.TP
X\fBl,L\fR
X(List) List files matching a file pattern you are requested before
or all tagged files
X.TP
X\fBm,M\fR
X(Move) Move or rename the current file or tagged files.
You are requested for the new file name or a destination
directory where to move the current file or tagged files
Instead of entering the name of a destination directory
you can select a directory using C-n and C-p
or directly on the \fItree screen\fR with CR
X.TP
X\fBn\fR
Change the sort criteria from lexical order to modification time order
or vice versa and resort the file list
X.TP
X\fBp,P\fR
X(Print) Print out the current file or tagged files
X.TP
X\fBr,R\fR
X(Remove) Remove the current file or tagged files.
Before removing you are asked if you really
want to remove the current file or tagged files
X.TP
X\fBs,S\fR
X(Stat) Switch to the \fIstatus screen\fR
display all status information of the current or tagged files
and change owner, group and access rights of
the current file or tagged files
X.TP
X\fBt,T\fR
X(Tag) Tag  the current file or files matching a file pattern
you are requested before for further processing
X.TP
X\fBu,U\fR
X(Untag) Untag the current file or files matching a file pattern
you are requested before
X.TP
X\fBv,V\fR
X(View) View the current file or tagged files
X.TP
X\fBx,X\fR
XExecute the current file or tagged files.
If a filetype command is defined for this file
you can execute this filetype command,
otherwise you are requested for a command
or for parameters to execute
X.TP
X\fBz\fR
Zoom files matching a file pattern
X.TP
X\fB>\fR
If the current file is a directory
change to the \fIfile screen\fR of this directory
X.TP
X\fB<\fR
Change back to the \fIfile screen\fR of the parent directory
X.TP
X\fB/\fR
Rebuild the file list (i.e. after shell escape)
X.TP
X\fB0\fR
Switch the menuline from the default to the user defined
file commands or vice versa
X.TP
X\fB1..9\fR
XExecute the user defined file commands 1 .. 9
X.PP
XFor further information about file patterns for the commands find,
grep, list, tag and untag see the section \fIfile patterns\fR below.
XFor user defined file commands see the section
X\fIvariables\fR.
XFor filetype command execution invoked with the command \fBx\fR
see the section \fIfiletype commands\fR below.
X.SH LINE EDITOR COMMANDS
X.LP
Many \fButree\fR commands need some user input for
further processing which is done with a builtin
simple line editor.
Many commands pre-set the input buffer with
a default input line if this default is known.
XFor some commands you can use the keys
C-n and C-p to scroll in already existing
input lists and select an input line
for editing or processing
without entering the line completely.
The line editor knows about the following functions:
X.sp
X.TP 20
X\fBCR,NL\fR
Accept and send the input line
X.TP
X\fBC-c,C-y\fR
Cancel input and leave the line editor
X.TP
X\fBC-o\fR
Switch from overwrite-mode to insert-mode or vice versa
X.TP
X\fBC-l\fR
Redisplay the input line
X.TP
X\fBC-f\fR
Move the cursor one character forward
X.TP
X\fBC-b\fR
Move the cursor one character backward
X.TP
X\fBC-a\fR
Move the cursor to the beginning of the input line
X.TP
X\fBC-e\fR
Move the cursor to the end of the input line
X.TP
X\fBC-v\fR
Scroll horizontally forward the input line
X.TP
X\fBC-w\fR
Scroll horizontally backward the input line
X.TP
X\fBC-d\fR
Delete one character under the cursor
X.TP
X\fBC-h,DEL\fR
Delete one character left from the cursor
X.TP
X\fBC-x\fR
Delete the input line completely
X.TP
X\fBC-k\fR
Delete the input line from the cursor position to the end
X.TP
X\fBC-t\fR
Transpose two characters under and left from the cursor
X.TP
X\fBC-r\fR
Display help pages and switch to the \fIhelp screen\fR
X.TP
X\fBC-@\fR
Set a mark at the current cursor position
X.TP
X\fBC-g\fR
Move the cursor to the previously marked position
X.TP
X\fBC-n\fR
Get the next entry into the line editor
X.TP
X\fBC-p\fR
Get the previous entry into the line editor
X.PP
All other printable characters are appended at the end of input line,
inserted in insert-mode
or overwrite the character under the cursor in overwrite-mode.
The current mode is displayed at the end of the help line.
Most line editor commands are also available with function keys,
see the section \fIfunction keys\fR below.
X.SH VARIABLES
X.LP
Utree knows about and uses the following variables which may be
set or unset at startup in the startupfile \fB$HOME/.utree\fR,
with some commandline options (see \fIoptions\fR above),
or the variables command (\fB=\fR) on the \fIvariables screen\fR:
X.sp
X.TP 20
X\fBBELL\fR
or \fBBL\fR: Allow ringing of the bell if set
X.TP
X\fBCLOCK\fR
or \fBCL\fR: Show and update clock every second if set
X.TP
X\fBGRAPHCHARS\fR
or \fBGC\fR: Use the graphical character set if set.
Not all terminal database termcap or terminfo
definitions of the graphical character set are
correct
X.TP
X\fBTERMSCROLL\fR
or \fBTS\fR: Use hardware terminal scrolling if set.
On some terminals (i.e. on the X terminal emulator xterm)
redrawing the screen may be faster than scrolling
X.TP
X\fBSCANTREE\fR
or \fBST\fR: Allow scanning the tree for changes if set.
Many commands scan the directory tree after execution
what may take some time.
Prohibiting tree scanning
therefore may speed up \fButree\fR a little bit
X.TP
X\fBWARNDIRS\fR
or \fBWD\fR: Allow warnings and requests about unreadable directories if set
X.TP
X\fBLEXSORT\fR
or \fBLS\fR: Sort filenames in lexical order if set,
in order of modification times if not set.
X.TP
X\fBAUTOSAVE\fR
or \fBAS\fR: Save changes in variables or filetype commands definitions,
key bindings and history list
to appropriate files in the home directory
X.TP
X\fBTREEINDENT\fR
or \fBTI\fR: Set the tree level indention column (3 .. 9) if possible.
Normally the tree level indention column is calculated dependent
on the number of screen columns and the maximal filesystem depth automatically
X.TP
X\fBVIDEOMODE\fR
or \fBVM\fR: Set using of video attributes.
X2 means use all possible attributes and their combinations.
X1 means use the attributes reverse and underline only.
X0 means don't use any video attribute.
X.TP
X\fBFILELINES\fR
or \fBFL\fR: Number of lines of the file window on the \fItree screen\fR
X(1 .. 9, default 3)
X.TP
X\fBHISTSIZE\fR
or \fBHS\fR: Maximal number of shell commands which are hold
in the shell commands history list (6 .. 99, default: 22)
X.TP
X\fBEDITOR\fR
or \fBED\fR: Program for editing files.
When redefining the editor variable don't forget to
check and set or unset the editopts variable for
editor options
X.TP
X\fBEDITOPTS\fR
or \fBEO\fR: File editor options
X.TP
X\fBPAGER\fR
or \fBPG\fR: Program for viewing files.
When redefining the pager variable don't forget to
check and set or unset the pageopts variable
for pager options
X.TP
X\fBPAGEOPTS\fR
or \fBPO\fR: File pager options
X.TP
X\fBXDUMPER\fR
or \fBXD\fR: Program for hexdumping files.
When redefining the hexdumper variable don't forget to
check and set or unset the xdumpopts variable
for hexdumper options
X.TP
X\fBXDUMPOPTS\fR
or \fBXO\fR: File hexdumper options
X.TP
X\fBLPRINTER\fR
or \fBLP\fR: Program for printing files or sending files to the
printer spooling system.
When redefining the lineprinter variable don't forget to
check and set or unset the lprintopts variable
for lineprinter options
X.TP
X\fBLPRINTOPTS\fR
or \fBLO\fR: Printer options
X.TP
X\fBBACKUP\fR
or \fBBK\fR: Program or shell script for backing up a directory or tree
X.TP
X\fBBACKUPOPTS\fR
or \fBBO\fR: Backup options
X.TP
X\fBSHELL\fR
or \fBSH\fR: Interactive shell for shell escape
X.TP
X\fBTREECMD1..9\fR
or \fBT1..9\fR: User defined \fItree screen\fR commands 1 .. 9
X.TP
X\fBFILECMD1..9\fR
or \fBF1..9\fR: User defined \fIfile screen\fR commands 1 .. 9
X.PP
Variables are set with a line '\fBvariable=value\fR'
or '\fBshorthand=value\fR'
X(i.e. '\fBtreecmd1=ps -ef\fR' or '\fBt1=ps -ef\fR')
and unset with a line '\fBvariable=\fR' or '\fBshorthand=\fR'
X(i.e. '\fBt1=\fR').
When defining user tree or file commands some sprintf
like format characters lead in by a percent sign (\fB%\fR) have a
special meaning and are expanded before the command is executed.
XFor further information about the command line format see the
section \fIline formats\fR below.
X.br
The last sharp sign (\fB#\fR) in a variable definition is used as leadin
for a menu item of the defined user file or tree command.
XExample: the variable definition '\fBfc1=wc -l %F #Count\fR' for the user
defined file command 1 is expanded to '\fBwc -l filename\fR'
and in the user command file menu '\fBCount\fR' is displayed
behind menu item 1.
X.SH FILETYPE COMMANDS
X.LP
On \fIfile screen\fR you can execute a file or a command on it
with the \fButree\fR execute command (\fBx\fR).
You are requested for parameters if the current file is executable,
for a command to execute on the
current file if it is not executable.
XFor a type of file you can define so called \fIfiletype commands\fR
which are called if the current file matches a given file pattern.
X.br
XFiletype commands can be set and unset at startup in
the startupfile \fB$HOME/.utree\fR,
with the commandline option \fB-d\fR
or the filetype command (\fB:\fR) similar
to setting and unsetting variables.
XFiletype commands are set with a line like '\fBfiletype:command\fR'
X(i.e. '\fB*.c:cc -c -O\fR').
The command (i.e. '\fBcc -c -O\fR') is then executed
if the current file matches the given file pattern
X(i.e. '\fB*.c\fR' for a C source file ending with '\fB.c\fR').
XFiletype commands are unset with a line '\fBfiletype:\fR'
X(i.e. '\fB*.c:\fR').
X.br
When defining filetype commands some sprintf like format characters
lead in by a percent sign (\fB%\fR) have a special meaning and are
expanded before the command is executed. For further information
about file patterns and the format line
characters and her meaning
see the sections \fIfile patterns\fR
and \fIline formats\fR below.
X.SH LINE FORMATS
X.LP
When defining a user tree or file command
or a filetype command some sprintf like format line
characters are known and expanded before the command is executed.
These format line characters and their meaning are:
X.sp
X.TP 20
X\fB%B\fR or \fB%b\fR
is expanded to the basename (filename without extension)
of the current file or directory
X.TP
X\fB%D\fR or \fB%d\fR
is expanded to the full pathname of the current directory
X.TP
X\fB%F\fR or \fB%f\fR
is expanded to the filename of the current file or directory
X.TP
X\fB%H\fR or \fB%h\fR
is expanded to the pathname of your home directory
X.TP
X\fB%P\fR or \fB%p\fR
is expanded to the full pathname of the current file or directory
X.TP
X\fB%R\fR or \fB%r\fR
is expanded to the pathname of the root directory
from where \fButree\fR was started
X.TP
X\fB%S\fR or \fB%s\fR
is expanded to additional parameter(s) for a command which are requested
before the command is executed
X.PP
The command line '\fBcommand %s %f >%b.out\fR' i.e. is expanded before execution
to '\fBcommand parameters filename >basename.out\fR'
with filename of the current file or directory (\fB%f\fR),
basename.out of the current file or directory (\fB%b.out\fR)
and additional parameters (\fB%s\fR)
which are requested before command execution.
X.br
XFor further information about tree, file and filetype commands
see the sections \fIvariables\fR and \fIfiletype commands\fR.
X.SH FILE PATTERNS
X.LP
Some commands (list, find, grep, tag or untag) require
file patterns for matching files using some
special (or meta) characters.
X.br
Shell like filename pattern matching interprets the
following meta characters:
X.sp
X.TP 20
X\fB*\fR
matches all characters in a filename
X.TP
X\fB?\fR
matches one character in a filename
X.TP
X\fB[class]\fR
matches one character from a character class.
A character class includes all characters enclosed between
the opening and closing brackets (\fB[\fR and \fB]\fR).
If in a class definition a minus sign (\fB-\fR) is found
between two other characters
this means the range from the character before and the
character behind the minus sign.
If the first character of a class definition is a exclamation mark
X(\fB!\fR) this means matching of all characters excluded those
defined in the class, i.e.
X.TP
X[abc]
matches the characters 'a', 'b' and 'c'
X.TP
X[a-z_]
matches the characters from 'a' to  'z' and '_'
X.TP
X[!a-z_]
matches all characters except 'a' to 'z' and '_'
X.PP
XFile size pattern matching interprets the following
meta characters:
X.sp
X.TP 20
X\fB=size\fR
matches all files of size \fBsize\fR
X.TP
X\fB!size\fR
matches all files not of size \fBsize\fR
X.TP
X\fB>size\fR
matches all files larger than \fBsize\fR
X.TP
X\fB<size\fR
matches all files smaller than \fBsize\fR
X.PP
Size may be specified in bytes (\fBb\fR, default),
kilo bytes (\fBk\fR) or mega bytes (\fBm\fR),
i.e. '\fB>2k\fR' matches all files larger than
X2 kilo bytes or 2048 bytes.
X.sp
X.PP
The additional file time pattern matching interprets the
following meta characters:
X.sp
X.TP 20
X\fB)time\fR
matches all files modified within \fBtime\fR
X.TP
X\fB(time\fR
matches all files not modified within \fBtime\fR
X.PP
Time may be specified in minutes (\fBm\fR),
hours (\fBh\fR, default), days (\fBd\fR) or weeks (\fBw\fR),
i.e. '\fB)2d\fR' matches all files modified within last 2 days.
X.sp
To combine shell like filename patterns and/or
additional file size and modification time patterns use
X.sp
X.TP 20
X\fB&\fR
for \fBAND\fRing of patterns
X.TP
X\fB|\fR
for \fBOR\fRing of patterns
X.PP
If a character is preceeded by a backslash or enclosed in quotes
his interpretation is suppressed and he is used as he is.
X.SH KEY BINDINGS
X.LP
All defaults key bindings are listed in the section
X\fIkey naming conventions and default key bindings\fR above.
All supported function keys if defined in the termcap or
terminfo terminal database and their default bindings
are listed in the next section.
Rebindings of default keys or additional bindings
of other keys may be done in terminal dependent
startupfiles \fButree-TERM\fR in a global directory
containing \fButree\fR startupfiles or in
files \fB.utree-TERM\fR in your home directory where \fBTERM\fR denotes
the terminal type as defined in the environment variable \fBTERM\fR.
These startup files are built from lines
like \fB'key_sequence=utree_key'\fR
or \fB'key_sequence="string"'\fR.
Key_sequence describes the function key string,
utree_key the \fButree\fR key or function name,
a string enclosed in braces a string to insert
into the input buffer.
A comment lead in by a sharp sign (#) should
contain the name of the bound key.
XFor defining key sequences of function keys
control keys are defined with a
leading caret (^, i.e. ^x, ^? means DEL)
and some other special characters
may be defined lead in by a backslash (\e).
These escaped characters and their meaning are:
b backspace (^h),  f formfeed (^l),
n newline (^j), r return (^m), t tab (^i),
e or E escape (^[ or ESC) and s space.
If a backslash is followed from up to three
digits this defines an octal given character.
I.e. the definition '\ee^O\e003=END' binds the
keystring <ESCAPE> <CONTROL-O> <ASCII-3> to the
X\fButree\fR key or function END.
X.PP
The simplest way to define keys is to switch
to the \fIbindings screen\fR and there to do all bindings.
You have only to hit the key to bind and terminate
the key sequence with CR or NL.
Therefore CR or NL or key sequences containing CR or NL
cannot be bound on the \fIbindings screen\fR.
Then you have to enter the \fButree\fR name where the key
is to bind to.
You can use C-n and C-p to select the wanted name.
At last you should give a short comment to the
bound key(i.e. the key name) for documentation.
If you want to bind a key for insertion of a string
X(and so to bind function keys to simple letter commands)
you have to enter the string enclosed in braces.
I.e. the binding \fB'\eeh="h"'\fR binds the
key <ESCAPE> <h> to the string <h> and the
so called help.
Any bindings you have done on the \fIbindings screen\fR
are saved to a file \fB.utree-TERM\fR into your home directory
if the variable AUTOSAVE is set.
X.SH FUNCTION KEYS
X.LP
The following function keys are supported by \fButree\fR
and pre-bound at startup to appropriate functions
if they are defined in your system's termcap or terminfo database:
X.sp
X.TP 20
X\fBCursorRight\fR
Move forward (FORWARD, \fBC-f\fR)
X.TP
X\fBCursorLeft\fR
Move backward (BACKWARD, \fBC-b\fR)
X.TP
X\fBCursorUp\fR
Move up (PREVIOUS, \fBC-p\fR)
X.TP
X\fBCursorDown\fR
Move down (NEXT, \fBC-n\fR)
X.TP
X\fBHome/Begin\fR
Move to beginning (BEGIN, \fBC-a\fR)
X.TP
X\fBEnd\fR
Move to end (END, \fBC-e\fR)
X.TP
X\fBNextPage/PageDown\fR
Move one page down (NEXTPAGE, \fBC-v\fR)
X.TP
X\fBPrevPage/PageUp\fR
Move one page up (PREVPAGE, \fBC-w\fR)
X.TP
X\fBScrollUp\fR
Scroll one line up (UP, \fBC-u\fR)
X.TP
X\fBScrollDown\fR
Scroll one line down or delecte character (DOWN, \fBC-d\fR)
X.TP
X\fBInsert\fR
Change to directory (\fB>\fR) or
switch insert/overwrite mode (INSERT, \fBC-o\fR)
X.TP
X\fBDelete\fR
Change to parent directory (\fB<\fR)
or delete character under cursor like (DELETE, \fBC-h\fR)
X.TP
X\fBClear\fR
Refresh screen or input line (REFRESH, \fBC-l\fR)
X.TP
X\fBHelp\fR
Call the help menu (HELP, \fBC-r\fR)
X.TP
X\fBSelect\fR
Select and/or accept (SELECT, \fBCR,NL\fR)
X.TP
X\fBDo/Command\fR
Select and/or accept (SELECT, \fBCR,NL\fR)
X.TP
X\fBMark\fR
Set a mark (SETMARK, \fBC-@\fR)
X.TP
X\fBEnter\fR
Select and/or accept (SELECT, \fBCR,NL\fR)
X.PP
This function keys may be rebound
or other function keys may be bound
on the \fIbindings screen\fR.
XFor more information about key bindings
see the section \fBkey bindings\fR above.
X.SH ENVIRONMENT
X.LP
X.TP 20
X\fBUTREE\fR
Some boolean and numerical settings for \fButree\fR
X.TP
X\fBUTLIB\fR
Directory for \fButree\fR help pages and startup files
X.TP
X\fBHOME\fR
User's home directory
X.TP
X\fBTERM\fR
Terminal type
X.TP
X\fBEDITOR\fR
XFile editor
X.TP
X\fBPAGER\fR
XFile pager/viewer
X.TP
X\fBSHELL\fR
Interactive shell for shell escape
X.PP
X.SH FILES
X.LP
X.TP 20
X\fBHOME/.utreelist\fR
Tree list file of user's filesystem
X.TP
X\fBHOME/.utreehist\fR
History list of shell commands
X.TP
X\fBHOME/.utree\fR
User's \fButree\fR startup file
containing variables and filetype commands definitions
X.TP
X\fBUTLIB/utree\fR
Global \fButree\fR startup file
containing variables and filetype commands definitions
X.TP
X\fBUTLIB/utree-TERM\fR
Global key bindings for terminal type TERM
X.TP
X\fBHOME/.utree-TERM\fR
User's key bindings for terminal type TERM
X.TP
X\fBUTLIB/utree.help\fR
X\fBUtree\fR help pages
X.TP
X\fBBIN/utree.backup\fR
Backup shell script or program
X.TP
X\fBBIN/utree.mklist\fR
Create directory tree list shell script
X.TP
X\fBBIN/utree.prlist\fR
Display or print a formatted tree list file
X.PP
X\fBUTLIB\fR can be a system default directory containing
library files (i.e. /usr/local/lib)
defined at compile time or a directory defined in the
environment variable \fBUTLIB\fR.
X\fBBIN\fR is a public directory containing executable
files (i.e. /usr/local/bin) and should be
included in the command search path environment variable \fBPATH\fR.
X.SH SEE ALSO
X.LP
utree.prlist(1L)
X.br
cp(1) grep(1) ls(1) mv(1) rm(1)
X.br
du(1) mkdir(1) rmdir(1)
X.br
find(1) sh(1)
X.SH BUGS
X.LP
Changes in filesystem after shell escape or editor session
are not always detected.
X.br
Directory tree depth >32 may be confusing.
X.br
Screen sizes smaller than 80x24 may be confusing.
X.br
Symbolic links to directories may be confusing.
X.br
On most BSD systems changing owner and/or group of files
for normal users is not allowed.
X.SH AUTHOR
X.LP
Peter Klingebiel
X.SH COPYRIGHT
X.LP
X\(co 1991/1992 Peter Klingebiel & UNIX Magazin Munich
X.sp
Permission is granted to copy and distribute \fButree\fR in modified
or unmodified form, for noncommercial use, provided (a) this copyright
notice is preserved, (b) no attempt is made to restrict redistribution
of this file, and (c) this file is not distributed as part of any
collection whose redistribution is restricted by a compilation copyright.
X
END_OF_FILE
if test 43554 -ne `wc -c <'doc/utree.1'`; then
    echo shar: \"'doc/utree.1'\" unpacked with wrong size!
fi
# end of 'doc/utree.1'
fi
echo shar: End of archive 7 \(of 8\).
cp /dev/null ark7isdone
MISSING=""
for I in 1 2 3 4 5 6 7 8 ; do
    if test ! -f ark${I}isdone ; then
    MISSING="${MISSING} ${I}"
    fi
done
if test "${MISSING}" = "" ; then
    echo You have unpacked all 8 archives.
    rm -f ark[1-9]isdone
else
    echo You still need to unpack the following archives:
    echo "        " ${MISSING}
fi
##  End of shell archive.
exit 0