* new version 2.20.9.
[alpine.git] / doc / pilot.1
blob4ddcd16d78e35d5669e905160c781d64faf2f2f6
1 .TH pilot 1 "Version 1.1"
2 .SH Name
3 pilot \- simple file system browser in the style of the Alpine Composer
4 .SH Syntax
5 .B pilot
7 .I options
8 ] [
9 .I directory
11 .SH Description
12 \fIPilot\fR is a simple, display-oriented file system browser based on
13 the Alpine message system composer.  As with Alpine, commands are 
14 displayed at the bottom of the screen, and context-sensitive
15 help is provided.
16 .PP
17 \fIPilot\fR displays the current working directory at the top of the
18 screen.  The directory's contents are displayed in columns of file name,
19 file size pairs.  Names that are directories are indicated by the name
20 "(dir)" in place of the file size.  The parent of the current working
21 directory is indicated by the file name ".." and size of "(parent dir)".
22 File names that are symbolic links to other files are displayed with a
23 file size of "--".
24 .PP
25 Several basic file manipulation commands are provided: Delete, Rename,
26 Copy, View, Launch, and Edit.  The "View" and "Edit" commands operate on
27 text files only.  By default, the "View" command displays files
28 using "alpine -F", but will respect the environment variable PAGER if set.
29 The "Edit" command simply invokes "pico".  The "Launch" command provides
30 a convenient way to either execute the selected file or to run an 
31 application on it.
32 .PP
33 More specific help is available in \fIpilot\fR's online help.
34 .SH Options
35 .IP \fB-a\fR
36 Display all files including those beginning with a period (.).
37 .IP \fB-f\fR
38 Use function keys for commands.  This option supported only in 
39 conjunction with UW Enhanced NCSA telnet.
40 .IP \fB-g\fR
41 Enable "Show Cursor" mode.  Cause cursor to be positioned
42 before the current selection rather than placed at the lower left of the
43 display.
44 .IP \fB-j\fR
45 Enable "Goto" command.  This enables the command to permit explicitly
46 telling \fIpilot\fR which directory to visit.
47 .IP \fB-m\fR
48 Enable mouse functionality.  This only works when \fIpilot\fR is run from
49 within an X Window System "xterm" window.
50 .IP \fB-n\fIn\fB\fR
51 The \-n\fIn\fR option enables new mail notification.  The \fIn\fR 
52 argument is optional, and specifies how often, in seconds, your 
53 mailbox is checked for new mail.  For example, \-n60 causes \fIpilot\fR 
54 to check for new mail once every minute.  The default interval is 180 
55 seconds, while the minimum allowed is 30. (Note: no space between "n" and 
56 the number) 
57 .IP \fB-o\ \fIdir\fB\fR
58 Sets operating directory.  Only files within the specified directory are
59 accessible and browsing is limited to the specified directory subtree.
60 .IP \fB-v\fR
61 Enable single vertical column display.
62 .IP \fB-x\fR
63 Disable keymenu at the bottom of the screen.
64 .IP \fB-z\fR
65 Enable ^Z suspension of \fIpilot\fR.
66 .IP \fB-q\fR
67 Termcap or terminfo definition for input escape sequences are used in
68 preference to sequences defined by default.  This option is only available
69 if \fIpilot\fR was compiled with the TERMCAP_WINS define turned on.
70 .IP \fB-setlocale_ctype\fR
71 Do setlocale(LC_CTYPE) if available. Default is to not do this setlocale.
72 .IP \fB-no_setlocale_collate\fR
73 Do not do setlocale(LC_COLLATE). Default is to do this setlocale.
74 .fi
75 .SH Authors
76 Michael Seibel <mikes@cac.washington.edu>
77 .br
78 Copyright 1994-2007 by the University of Washington.
79 .SH "See Also"
80 alpine(1)
81 .br
82 Source distribution (part of the Alpine Message System):
84 $Date: 2005/01/14 20:40:14 $