⟦d4bab73cb⟧

TextFile

.TH MAX 1 "X WINDOWS"
.SH NAME
max \- directory browser (X\-based)
.SH SYNOPSIS
.in +.5i
.ti -.5i
.B max
\%[options]
\%[=geometry]
\%[host:display]
.in -.5i
.SH DESCRIPTION
\fImax\fR is a directory browser for X windows.
When invoked, it creates a paned window containing:
a pane for each directory above the user's working directory,
these are called \fIview\fR windows;
a pane for the user's current working directory,
this is called the \fIcurrent\fR window;
a pane for user\-defined functions,
this is called the \fIfunctions\fR window;
a pane for built\-in commands,
this is called the \fIcommands\fR window;
a pane for built\-in options,
this is called the \fIoptions\fR window;
and,
a pane for messages,
this is called the \fImessages\fR window.
.PP
With the exception of the messages window,
all of the other panes are composed of several buttons.
In the case of view windows and the current window,
there is a button for each file in the given directory.
In the case of the functions window,
there is a button for each user\-defined function.
In the case of the commands and options window,
there is a button for each built\-in command or option (respectively).
With the exception of buttons in the current window,
an action is bound to each button.
The current window is special as the state of each button,
as indicated via reverse-video,
indicates whether the file is considered selected.
.SH OPTIONS
\fImax\fR understands several options.
If the option begins with a `+' instead of a `\-',
then the option is restored to its default value.
These options override those set in the user's initialization file for
\fImax\fR
(see the \fBX\0DEFAULTS\fR section below).
.TP
.B \-advance
This causes \fImax\fR to automatically advance the \*(lqselected\*(rq file
in the current window after executing a user\-defined function.
.TP
.B \-autoraise
This causes \fImax\fR to automatically raise itself when the cursor enters
the paned window.
In addition,
if \fImax\fR is run under \fIxterm\fR,
then \fImax\fR will raise \fIxterm\fR's window prior to executing each
user\-defined function.
.TP
.B \-dotfiles
This causes \fImax\fR to include files beginning with ``.'' in the view and
current windows.
.TP
.B \-messagemode
This puts \fImax\fR in message mode.
This is intended for upwards\-compatibility with the next version of \fImax\fR.
.TP
.B \-reselect
Normally, after executing a user\-defined function,
\fImax\fR will de\-select the files in the current window.
This option inhibits this behavior.
.TP
.B \-sort
This tells \fImax\fR to sort the selected files based on the order in which
they were selected by the user
(instead of the default, which is to sort based on the order in which they
appear in the current window).
.TP
.BI = geometry
The standard X geometry specification is accepted.
.SH MOUSE
Click\-left is used to put \fImax\fR through its paces;
click\-middle and click\-right are ignored.
When the mouse is over a window which can be clicked,
that window is highlighted.
.PP
In a view window,
clicking on a button causes \fImax\fR to change directories to the associated
part the filesystem.
If the button is not a directory,
no action is taken (the button will not highlight).
In the current window,
clicking on a button toggles the selection status of the associated file.
In the functions or commands window,
clicking on a button invokes the associated function or command (respectively).
Similarly,
in the options window,
clicking on a button toggles that value of the associated option.
.PP
Note that with the exception of the current window and the options window,
the action associated with the click does not occur until the mouse button is
released.
Further,
if the user moves the mouse outside of the window prior to relasing the
button,
then the action will not be invoked.
This is believed to be a \*(lquser\-friendly\*(rq feature.
If experience dictates otherwise,
this override mechanism will be removed.
.SH "BUILT\-IN COMMANDS"
The built\-in commands in \fImax\fR are used to manipulate the selection
status of files in the current window.
.TP
.B Clear
Deselects any selected files.
.TP
.B Set
Selects all files.
.TP
.B Invert
Toggles the selection status of all files.
.TP
.B Next
Unselects the selected file (if any) and selects the next one.
If no files are selected, the first file is selected.
If more than one file is selected,
\fImax\fR complains.
.TP
.B Previous
Analogous to the Next command, but goes backwards instead of forwards.
.TP
.B ChangeDirectory
If only one file is selected and it is a directory,
then \fImax\fR changes its working directory accordingly.
This command is necessary since,
unlike buttons associated with directories in other windows,
in the current window, buttons are used for selection purposes.
.TP
.B Exit
Terminates \fImax\fR.
.SH "BUILT\-IN OPTIONS"
The built\-in options in \fImax\fR are used to override initialization
and command-line settings.
.TP
.B advance
Toggles the advance option described above.
.TP
.B autoRaise
Toggles the autoRaise option described above.
.TP
.B dotFiles
Toggles the dotFiles option described above.
Note that this will not take effect until \fImax\fR changes its working
directory.
.TP
.B messageMode
Toggles the messageMode option described above.
Note that this will not take effect until \fImax\fR changes its working
directory.
.TP
.B reSelect
Toggles the reSelect option described above.
.TP
.B sort
Toggles the sort option described above.
.SH "USER DEFINED FUNCTIONS"
In the user's initialization file for \fImax\fR,
lines of the form:
.sp
.nf
.in +.5i
functions.\fIname\fR.command:\0keyword\0arguments\0...
.in -.5i
.fi
.sp
are used to describe user\-defined functions.
If no functions are defined during initialization,
\fImax\fR reads a site\-dependent initialization file.
In addition,
\fImax\fR also looks for a \fI\&.maXdefaults\fR file in the working directory
for additional definitions.
The keyword and its argument are separated by any number of blanks and/or tab
characters;
however, double\-quotes may be used to prevent separation between arguments.
Currently, only one keyword is defined, \*(lqf.exec\*(rq.
.PP
The f.exec keyword takes one or more arguments.
At most one of these arguments contains an ``%\-expression''.
This expression defines how f.exec combines the selected files:
.sp
.nf
.in +.5i
.ta \w'%M  'u
%f	run arguments once for each selected file
%F	run arguments once with all selected files
%r	run arguments once for each selected regular file
%R	run arguments once with all selected regular files
%d	run arguments once for each selected directory file
%D	run arguments once with all selected directory files
%n	run arguments once ignoring all selected files
.re
.in -.5i
.fi
.sp
If no %\-expression is present,
then a trailing argument of ``%f'' is assumed.
Other uses of ``%'' are interpreted thusly:
\&``%%'' becomes an verbatim ``%'',
otherwise it is ignored.
(A \*(lqregular\*(rq file is anything other than a directory file.)
.PP
Consider a mythical initialization file:
.sp
.nf
.in +.5i
.ta \w'functions.View-D.command:  'u
functions.Echo.command:	f.exec echo %f
functions.Delete.command:	f.exec rm -i %F
functions.Edit.command:	f.exec emacs %r
functions.View-R.command:	f.exec more %R
functions.View-D.command:	f.exec ls -F %D
functions.CShell.command:	f.exec csh %n
.re
.in -.5i
.fi
.sp
This defines \*(lqEcho\*(rq to simply echo any selected files,
invoking echo once for each file;
whereas, \*(lqDelete\*(rq invokes rm exactly once,
with all of the selected files.
The \*(lqEdit\*(rq command invokes emacs once for each regular file selected.
The \*(lqView\-R\*(rq command invokes more once,
on all of the selected regular files;
whereas \*(lqView\-D\*(rq invokes ls once, with arguments, on all of the
selected directories.
Finally,
the \*(lqCShell\*(rq command doesn't care which files are selected,
it merely runs csh.
.PP
Since \fImax\fR runs all commands from the terminal it was invoked from,
\fImax\fR should run under a terminal emulator such as \fIxterm\fR.
In fact a useful invocation might be:
.sp
.nf
.in +.5i
xterm =80x40+0+0 \-n \*(lqmaX shell\*(rq \-e max =650x850\-0\-0
.in -.5i
.fi
.sp
followed by click\-right,
which puts \fIxterm\fR in the upper left corner and \fImax\fR in the lower
right corner.
The \fIxterm\fR window is used only when \fImax\fR is executing a
user\-defined function,
and terminates when \fImax\fR terminates.
This is also most useful,
in the author's opinion,
when both windows have autoRaise enabled.
.SH KEYBOARD
Currently, the keyboard is not used.
.SH MENU
Currently, no menus are used.
.SH "X DEFAULTS"
\fImax\fR uses the X Toolkit's resource database system.
Upon initialization,
it looks for one of several initialization files.
These files, and the searching order are listed in the \fBFILES\fR section
below.
In addition,
the file .maXdefaults in \fImax\fR's working directory is read for additional
descriptions of user\-defined functions.
These files are resource databases for the X Toolkit.
.PP
A resource database is similar in syntax to the standard 
\fI\&.Xdefaults\fR file, but has more powerful semantics.
The following options are available:
.TP
.B advance
initializes the advance option.
.TP
.B autoRaise
initializes the autoRaise option.
.TP
.B dotFiles
initializes the dotFiles option.
.TP
.B messageMode
initializes the messageMode option.
.TP
.B reSelect
initializes the reSelect option.
.TP
.B sort
initializes the sort option.
.PP
Further,
for those experienced with the X Toolkit:
all panes other than the messages window, are ButtonBoxes.
Buttons in the view panes are either CommandButtons (if directories) or
Labels (otherwise).
Buttons in the current window are BooleanButtons.
Buttons in the functions and commands windows are CommandButtons.
Buttons in the options window are BooleanButtons.
The message window is a Label.
.PP
Finally,
for sizing the application window,
\fImax\fR follows the MakeWindow conventions.
.SH FILES
.nf
.ta \w'$HOME/.maXdefaults  'u
$MAXDEFAULTS	Initialization resource database
	(interpreted relative to $HOME)
$HOME/.maXdefaults	Initialization resource database
$HOME/.Xresources	..
$HOME/.Xdefaults	..
/usr/new/lib/X/.Xdefaults	
	user\-defined functions (if none are described
	in the user's initialization resource database)
\&.maXdefaults	user\-defined functions
	(in the working directory)
.re
.fi
.SH ENVIRONMENT
DISPLAY \- the default host and display number
.SH DIAGNOSTICS
All obvious,
except for messages from the X Toolkit's resource conversion system,
which are a bit cryptic.
These usually indicate that you've asked for color resources on a monochrome
display.
.SH AUTHOR
Marshall T. Rose, Northrop Research and Technology Center
.SH BUGS
Many.  Here are the ones that probably won't get fixed until after the next
version of \fImax\fR:
.PP
\fImax\fR starts slowly.
Hopefully \fImax\fR will start faster under version 11.
In the meantime,
many users are amused by \fImax\fR's antics on the display during bootstrap.
.PP
If the dotFiles option is disabled,
then each \fImax\fR's working directory should not have any components that
start with a dot.
.PP
Instead of \fIexec\fR'ing its arguments directly,
f.exec should probably invoke a shell instead.
In addition,
it'd be nice for f.exec to support conditional %\-expressions
(i.e., do one thing if the selected file is regular, do another if the
selected file is a directory).
For example,
one might wish to define a a \*(lqview\*(rq command,
which runs \fImore\fR on regular files and \fIls\fR on directories.
.PP
Finally,
it'd be nice for f.exec to support a recursive %\-expression
(i.e., upon encountering a selected directory, treat each file in the
directory as selected and apply the rule on the resulting files.
This is problematic: consider what happens when the working directory is the
root, the usr directory is selected, and then you invoke a recursive
%\-expression.
.SH NOTES
The next version of \fImax\fR will be much more impressive.
DataMuseum.dk

DKUUG/EUUG Conference tapes

⟦d4bab73cb⟧ TextFile

Derivation

TextFile
