~ubuntu-branches/debian/stretch/alpine/stretch

« back to all changes in this revision

Viewing changes to doc/pico.1

  • Committer: Bazaar Package Importer
  • Author(s): Asheesh Laroia
  • Date: 2007-02-17 13:17:42 UTC
  • Revision ID: james.westby@ubuntu.com-20070217131742-99x5c6cpg1pbkdhw
Tags: upstream-0.82+dfsg
ImportĀ upstreamĀ versionĀ 0.82+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH pico 1 "Version 4.92"
 
2
.SH Name
 
3
pico \- simple text editor in the style of the Pine Composer
 
4
.SH Syntax
 
5
.B pico
 
6
[
 
7
.I options
 
8
] [
 
9
.I file
 
10
]
 
11
.SH Description
 
12
\fIPico\fR is a simple, display-oriented text editor based on
 
13
the Pine message system composer.  As with Pine, commands are 
 
14
displayed at the bottom of the screen, and context-sensitive
 
15
help is provided.  As characters are typed they are immediately 
 
16
inserted into the text.
 
17
.PP
 
18
Editing commands are entered using control-key
 
19
combinations.  As a work-around for communications programs that
 
20
swallow certain control characters, you can emulate a control key
 
21
by pressing ESCAPE twice, followed by the desired control character,
 
22
e.g. "ESC ESC c" would be equivalent to entering a ctrl-c.
 
23
The editor has five basic features: paragraph justification,
 
24
searching, block cut/paste, a spelling checker, and a file browser.
 
25
.PP
 
26
Paragraph justification (or filling) takes place in the paragraph that
 
27
contains the cursor, or, if the cursor is between lines, in the paragraph
 
28
immediately below.  Paragraphs are delimited by blank lines, or by lines
 
29
beginning with a space or tab.  Unjustification can be done immediately
 
30
after justification using the control-U key combination. 
 
31
.PP
 
32
String searches are not sensitive to case.  A search begins at the current
 
33
cursor position and wraps around the end of the text.  The most recent   
 
34
search string is offered as the default in subsequent searches.
 
35
.PP
 
36
Blocks of text can be moved, copied or deleted with creative use of the
 
37
command for mark (ctrl-^), delete (ctrl-k) and undelete (ctrl-u).
 
38
The delete command will remove text between the "mark" and the current 
 
39
cursor position, and place it in the "cut" buffer.  The undelete command
 
40
effects a "paste" at the current cursor position.
 
41
.PP
 
42
The spell checker examines all words in the text.  It then offers, in 
 
43
turn, each misspelled word for correction while 
 
44
highlighting it in the text.  Spell checking can be cancelled at any time.  
 
45
Alternatively, \fIpico\fR will substitute for the default spell checking 
 
46
routine a routine defined by the SPELL environment variable.  The replacement 
 
47
routine should read standard input and write standard output.
 
48
.PP
 
49
The file browser is offered as an option in the "Read File" and "Write Out"
 
50
command prompts.  It is intended to help in searching for specific files 
 
51
and navigating directory hierarchies.  Filenames with sizes and names of 
 
52
directories in the current working directory are presented for selection.
 
53
The current working directory is displayed on the top line of the display 
 
54
while the list of available commands takes up the bottom two.  Several 
 
55
basic file manipulation functions are supported:  file renaming, copying, 
 
56
and deletion.
 
57
.PP
 
58
More specific help is available in \fIpico\fR's online help.
 
59
.SH Options
 
60
.IP \fB+\fIn\fB\fR
 
61
Causes \fIpico\fR to be started with the cursor located \fIn\fR lines 
 
62
into the file. (Note: no space between "+" sign and number)
 
63
.IP \fB-a\fR
 
64
Display all files including those beginning with a period (.).
 
65
.IP \fB-b\fR
 
66
Enable the option to Replace text matches found using the
 
67
"Where is" command.
 
68
.IP \fB-d\fR
 
69
Rebind the "delete" key so the character the cursor is on is rubbed out
 
70
rather than the character to its left.
 
71
.IP \fB-e\fR
 
72
Enable file name completion.
 
73
.IP \fB-f\fR
 
74
Use function keys for commands.  This option supported only in 
 
75
conjunction with UW Enhanced NCSA telnet.
 
76
.IP \fB-h\fR
 
77
List valid command line options.
 
78
.IP \fB-j\fR
 
79
Enable "Goto" command in the file browser.  This enables the command to
 
80
permit explicitly telling \fIpilot\fR which directory to visit.
 
81
.IP \fB-g\fR
 
82
Enable "Show Cursor" mode in file browser.  Cause cursor to be positioned
 
83
before the current selection rather than placed at the lower left of the
 
84
display.
 
85
.IP \fB-k\fR
 
86
Causes "Cut Text" command to remove characters from the cursor position
 
87
to the end of the line rather than remove the entire line.
 
88
.IP \fB-m\fR
 
89
Enable mouse functionality.  This only works when \fIpico\fR is run from
 
90
within an X Window System "xterm" window.
 
91
.IP \fB-n\fIn\fB\fR
 
92
The \-n\fIn\fR option enables new mail notification.  The \fIn\fR 
 
93
argument is optional, and specifies how often, in seconds, your 
 
94
mailbox is checked for new mail.  For example, \-n60 causes \fIpico\fR 
 
95
to check for new mail once every minute.  The default interval is 180 
 
96
seconds, while the minimum allowed is 30. (Note: no space between "n" and 
 
97
the number) 
 
98
.IP \fB-o\ \fIdir\fB\fR
 
99
Sets operating directory.  Only files within this directory are accessible.
 
100
Likewise, the file browser is limited to the specified directory subtree.
 
101
.IP \fB-r\fIn\fB\fR
 
102
Sets column used to limit the "Justify" command's right margin
 
103
.IP \fB-s\ \fIspeller\fR
 
104
Specify an alternate program
 
105
.I spell
 
106
to use when spell checking.
 
107
.IP \fB-t\fR
 
108
Enable "tool" mode.  Intended for when \fIpico\fR is used as the
 
109
editor within other tools (e.g., Elm, Pnews).  \fIPico\fR will not prompt
 
110
for save on exit, and will not rename the buffer during the "Write Out"
 
111
command.
 
112
.IP \fB-v\fR
 
113
View the file only, disallowing any editing.
 
114
.IP \fB-version\fR
 
115
Print Pico version and exit.
 
116
.IP \fB-w\fR
 
117
Disable word wrap (thus allow editing of long lines).
 
118
.IP \fB-x\fR
 
119
Disable keymenu at the bottom of the screen.
 
120
.IP \fB-z\fR
 
121
Enable ^Z suspension of \fIpico\fR.
 
122
.IP \fB-p\fR
 
123
Preserve the "start" and "stop" characters, typically Ctrl-Q and Ctrl-S,
 
124
which are sometimes used in communications paths to control data flow
 
125
between devices that operate at different speeds.
 
126
.IP \fB-Q\ \fIquotestr\fB\fR
 
127
Set the quote string.  Especially useful when composing email, setting this 
 
128
allows the quote string to be checked for when Justifying paragraphs.
 
129
A common quote string is "> ".
 
130
.IP \fB-q\fR
 
131
Termcap or terminfo definition for input escape sequences are used in
 
132
preference to sequences defined by default.  This option is only available
 
133
if \fIpico\fR was compiled with the TERMCAP_WINS define turned on.
 
134
.IP \fB-setlocale_ctype\fR
 
135
Do setlocale(LC_CTYPE) if available. Default is to not do this setlocale.
 
136
.IP \fB-no_setlocale_collate\fR
 
137
Do not do setlocale(LC_COLLATE). Default is to do this setlocale.
 
138
.PP
 
139
Lastly, when a running \fIpico\fR is disconnected (i.e., receives a 
 
140
SIGHUP), \fIpico\fR will save the current work if needed before exiting.
 
141
Work is saved under the current filename with ".save" appended.
 
142
If the current work is unnamed, it is saved under the filename "pico.save".
 
143
.PP
 
144
.SH Bugs
 
145
The manner in which lines longer than the display width are dealt
 
146
is not immediately obvious.  Lines that continue beyond the edge
 
147
of the display are indicated by a '$' character at the end
 
148
of the line.  Long lines are scrolled horizontally as the cursor 
 
149
moves through them.
 
150
.SH Files
 
151
.ta 1.75i
 
152
.nf
 
153
pico.save       Unnamed interrupted work saved here.
 
154
*.save  Interrupted work on a named file is saved here.
 
155
.fi
 
156
.SH Authors
 
157
Michael Seibel <mikes@cac.washington.edu>
 
158
.br
 
159
Laurence Lundblade <lgl@cac.washington.edu>
 
160
.br
 
161
Pico was originally derived from MicroEmacs 3.6, by Dave G. Conroy.
 
162
.br
 
163
Copyright 1989-2007 by the University of Washington.
 
164
.SH "See Also"
 
165
pine(1)
 
166
.br
 
167
Source distribution (part of the Pine Message System):
 
168
.br
 
169
   ftp://ftp.cac.washington.edu/mail/pine.tar.Z
 
170
 
 
171
.nf
 
172
$Date: 2005/04/28 18:28:33 $