1
<HTML><HEAD><TITLE>Pine Technical Notes: Command Line Arguments</TITLE></HEAD><BODY>
2
<H1>Command Line Arguments</H1>
4
<H2><A NAME="pine">Pine</A></H2>
6
<EM>Pine</EM> and <EM>PC-Pine</EM> can accept quite a few
7
command-line arguments.
8
Many of these arguments overlap with variables
9
in the <EM>Pine</EM> configuration file.
10
If there is a difference, then a flag set in the command line takes precedence.
11
Both <EM>Pine</EM> and <EM>PC-Pine</EM> expect command line arguments (other
13
preceded by the "-" (dash) as normally used by UNIX programs.
18
<DT> <EM>[addresses]</EM>
20
<DD> Send-to: If you give <EM>Pine</EM> an argument or arguments which
21
do not begin with a dash, <EM>Pine</EM> treats them as email addresses.
22
<EM>Pine</EM> will startup in
23
the composer with a message started to the addresses specified.
24
Once the message is sent, the <EM>Pine</EM> session closes.
25
Standard input redirection is allowed.
26
Separate multiple addresses with a space between them.
27
Addresses are placed in the "To" field only.
30
<DT> < <EM>file</EM>
32
<DD> <EM>Pine</EM> will startup in the composer with <EM>file</EM> read
33
into the body of the message.
34
Once the message is sent, the <EM>Pine</EM> session closes.
37
<DT> -attach <EM>file</EM>
39
<DD> Go directly into composer with given file attached.
42
<DT> -attachlist <EM>file-list</EM>
44
<DD> Go directly into composer with given files attached.
45
This must be the last option on the command line.
48
<DT> -attach_and_delete <EM>file</EM>
50
<DD> Go directly into composer with given file attached, delete when finished.
53
<DT> -aux <EM>local_directory</EM>
55
<DD> <EM>PC-Pine</EM> only.
56
This tells <EM>PC-Pine</EM> the local directory to use for storing auxiliary
57
files, like debug files, address books, and signature files. The pinerc may
63
<DD> <EM>PC-Pine</EM> only.
64
This tells <EM>PC-Pine</EM> to not display the splash screen upon startup.
65
This may be helpful for certain troubleshooting or terminal server scenarios.
70
<DD> If the personal configuration file doesn't already exist, exit.
71
This might be useful if the configuration file is accessed using some
72
remote filesystem protocol. If the remote mount is missing this will cause
73
<EM>Pine</EM> to quit instead of creating a new pinerc.
78
<DD> When used with the <CODE>-f</CODE> option, apply the <EM>n</EM>th context.
79
This is used when there are multiple folder collections (contexts) and you
80
want to open a folder not in the primary collection.
85
<DD> Configuration: Prints a sample system configuration file to the
86
screen or standard output. To generate an initial system configuration
90
pine -conf > /usr/local/lib/pine.conf
94
To generate a system configuration file using settings from an old
95
system configuration file, execute
98
pine -P old-pine.conf -conf > /usr/local/lib/pine.conf
101
A system configuration file is not required.
104
<DT> -convert_sigs <EM>-p pinerc</EM>
106
<DD> Convert signatures contained in signature files into literal signatures.
109
<DT> <A NAME="copy_abook">-copy_abook <EM><local_abook_file> <remote_abook_folder></EM>
111
<DD> Copy an address book file to a remote address book folder.
112
If the remote folder doesn't exist, it will be created.
113
If it exists but the first message in the folder isn't a remote address
114
book header message, the copy will be aborted.
115
This flag will not usually be used by a user.
116
Instead, the user will create a remote address book from within <EM>Pine</EM>
117
and copy entries from the local address book by using aggregate Save in
118
the address book screen.
121
<DT> <A NAME="copy_pinerc">-copy_pinerc <EM><local_pinerc_file> <remote_pinerc_folder></EM>
123
<DD> Copy a pinerc configuration file to a remote pinerc folder.
124
If the remote folder doesn't exist, it will be created.
125
If it exists but the first message in the folder isn't a remote pinerc
126
header message, the copy will be aborted.
127
This flag may be useful to users who already have a local pinerc file and
128
would like to convert it to a remote pinerc folder and use that instead.
129
This gives a way to bootstrap that conversion without having to manually
130
reset all of the variables in the remote pinerc folder.
133
<DT> -create_lu <EM>addrbook sort-order</EM>
135
<DD> Create auxiliary LookUp (index) file for <EM>addrbook</EM> and sort
136
<EM>addrbook</EM> in <EM>sort-order</EM>, which may be <EM>dont-sort</EM>,
137
<EM>nickname</EM>, <EM>fullname</EM>, <EM>nickname-with-lists-last</EM>,
138
or <EM>fullname-with-lists-last</EM>.
139
Only useful when creating global or shared address books.
140
The settings of the features
141
disable-setlocale-collate and enable-setlocale-ctype have no
142
effect when using the create_lu command.
143
See <A HREF="low-level.html#addrbook-lu">Address Book Lookup File</A>
144
for more information, especially the warning about copying the
145
address book after creating the lookup file.
148
<DT> -d <EM>debug-level</EM>
150
<DD> Debug Level: Sets the level of debugging information written by
152
<EM>Debug-level</EM> can be set to any integer 0-9.
153
A debug level of 0 turns off debugging for the session.
154
(Actually there are some levels higher than 9, but you probably don't
155
want to see them. Sensitive authentication information is hidden at
156
levels less than 10.)
159
<DT> -d <EM>keywords</EM>
161
<DD> You may use a more detailed version of the debugging flag to set
162
the debug level in separate parts of <EM>Pine</EM>.
163
The possibilities are flush, timestamp, imap=0..4, tcp, numfiles=0..31, and
165
<EM>Flush</EM> causes debugging information to be flushed immediately to
166
the debug file as it is written.
167
<EM>Verbose</EM> is the general debugging verbosity level.
168
<EM>Timestamp</EM> causes timestamps to be added to the debug file, which
169
is useful when you are trying to figure out what is responsible for delays.
170
<EM>Numfiles</EM> sets the number of debug files saved.
171
<EM>Imap</EM> sets the debug level for the debugging statements related
172
to the conversation with the IMAP server, and more generally, for the
173
debugging related to <EM>Pine</EM>'s interaction with the C-Client library.
174
If <EM>imap</EM> is set higher than 4, sensitive authentication information
175
will be included in the debug file.
176
<EM>Tcp</EM> adds more TCP/IP debugging information.
179
<DT> -f <EM>folder</EM>
181
<DD> Startup folder: <EM>Pine</EM> will open this folder in place
182
of the standard INBOX.
185
<DT> -F <EM>file</EM>
187
<DD> Open named text file for viewing and forwarding.
192
<DD> Help: Prints the list of available command-line arguments to the
198
<DD> <EM>Pine</EM> will start up in the FOLDER INDEX
199
screen instead of the MAIN MENU.
202
Configuration equivalent: <EM>initial-keystroke-list=i</EM>.
205
<DT> -I <EM>a,b,c,...</EM>
207
<DD> Initial Keystrokes: <EM>Pine</EM> will execute this comma-separated
208
sequence of commands upon startup.
209
This allows users to get <EM>Pine</EM> to start in any
210
of its menus/screens.
211
You cannot include any input to the composer in the initial keystrokes.
212
The key <Return> is represented by a ``CR'' in
213
the keystroke list; the spacebar is designated by the letters ``SPACE''.
214
Control keys are two character sequences beginning with ``^'', such as
216
A tab character is ``TAB''.
217
Function keys are ``F1'' - ``F12'' and the arrow keys are ``UP'',
218
``DOWN'', ``LEFT'', and ``RIGHT''.
219
A restriction is that you can't mix function keys and character keys in this
220
list even though you can, in some cases, mix them when running <EM>Pine</EM>.
221
A user can always use only <EM>character</EM> keys in the startup list even
222
if he or she is using <EM>function</EM> keys normally, or vice versa.
223
If an element in this list is a string of characters surrounded by double
224
quotes (") then it will be expanded into the individual characters in
225
the string, excluding the double quotes.
228
Configuration equivalent: <EM>initial-keystroke-list</EM>
233
<DD> For <EM>PC-Pine</EM> only, this option prompts for some basic
234
setup information, then exits.
239
<DD> Function-Key Mode: When invoked in this way, <EM>Pine</EM> expects
240
the input of commands to be function-keys.
241
Otherwise, commands are linked to the regular character keys.
244
Configuration equivalent: <EM>use-function-keys</EM> included in
245
<EM>feature-list</EM>.
250
<DD> Message-Number: When specified, <EM>Pine</EM> starts up in the
251
FOLDER INDEX screen with the current message being the specified
255
<DT> -nowrite_passfile
257
<DD> This tells <EM>Pine</EM> to use the passfile if there is one, but to
258
never offer writing new passwords to the passfile.
261
<DT> -o <EM>folder</EM>
263
<DD> Opens the INBOX (or a folder specified via the -f argument) ReadOnly.
266
<DT> -p <EM>pinerc</EM>
268
<DD> Uses the named file as the personal configuration file instead of
269
<EM>~/.pinerc</EM> or the default PINERC search sequence <EM>PC-Pine</EM> uses.
270
Pinerc may be either a local file or a remote configuration folder.
273
<DT> -P <EM>pinerc</EM>
275
<DD> Uses the named file as the system wide configuration file instead of
276
<EM>/usr/local/lib/pine.conf</EM> on UNIX, or nothing on <EM>PC-Pine</EM>.
277
Pinerc may be either a local file or a remote configuration folder.
280
<DT> -passfile <EM>passfile</EM>
282
<DD> This tells <EM>Pine</EM> what file should be used as the password file.
283
This should be a fully-qualified filename.
286
<DT> -pinerc <EM>file</EM>
288
<DD> Output fresh pinerc configuration to <EM>file</EM>, preserving the
289
settings of variables that the user has made.
290
Use <EM>file</EM> set to ``-'' to make output go to standard out.
295
<DD> Restricted Mode: For UNIX <EM>Pine</EM> only.
296
<EM>Pine</EM> in restricted mode can only send email to itself.
297
Save and export are limited.
300
<DT> -registry <EM>cmd</EM>
302
<DD> For <EM>PC-Pine</EM> only, this option affects the values of
303
<EM>Pine</EM>'s registry entries.
304
Possible values for <EM>cmd</EM> are set, noset, clear, clearsilent, and dump.
305
<EM>Set</EM> will always reset <EM>Pine</EM>'s registry
306
entries according to its current settings.
307
<EM>NoSet</EM> will never set any values in the registry, but it will
308
still use the values already set in the registry.
309
<EM>Clear</EM> will clear the registry values.
310
<EM>Clearsilent</EM> will silently clear the registry values.
311
<EM>Dump</EM> will display the values of current registry settings.
312
Note that the dump command is currently disabled.
313
Without the -registry option, <EM>PC-Pine</EM> will write values into
314
the registry only if there currently aren't any values set.
317
<DT> -sort <EM>key</EM>
319
<DD> Sort-Key: Specifies the order messages will be displayed in for the
321
<EM>Key</EM> can have the following values:
322
arrival, date, subject, orderedsubj, thread, from, size, score, to, cc,
323
arrival/reverse, date/reverse, subject/reverse, orderedsubj/reverse, thread/reverse,
324
from/reverse, size/reverse, score/reverse, to/reverse, and cc/reverse.
325
The default value is "arrival".
326
The <EM>key</EM> value reverse is equivalent to arrival/reverse.
329
Configuration equivalent: <EM>sort-key</EM>.
334
<DD> Some options may or may not be supported depending on how <EM>Pine</EM>
336
This is a way to determine which options are supported in the particular
337
copy of <EM>Pine</EM> you are using.
340
<DT> -url <EM>url</EM>
342
<DD> Open the given URL.
347
<DD> Version: Print version information to the screen.
352
<DD> Version: Print version information to the screen.
355
<DT> -x <EM>exceptions_config</EM>
357
<DD> Configuration settings in the exceptions config override your normal
359
<EM>Exceptions_config</EM> may be either a local file or a remote pinerc folder.
364
<DD> Enable Suspend: When run with this flag, the key sequence ctrl-z
365
will suspend the <EM>Pine</EM> session.
368
Configuration equivalent: <EM>enable-suspend</EM> included in
369
<EM>feature-list</EM>.
372
<DT> -<EM>option</EM>=<EM>value</EM>
374
<DD> Assign <EM>value</EM> to the config option <EM>option</EM>.
375
For example, <EM>-signature-file=sig1</EM> or
376
<EM>-feature-list=signature-at-bottom</EM>.
377
(Note: feature-list values are
378
additive and features may be preceded with no- to turn them off).
384
<H2><A NAME="pico">Pico</A></H2>
386
The following command line options are supported in <EM>Pico</EM>:
392
<DD> Causes <EM>Pico</EM> to be started with the cursor located <EM>n</EM>
393
lines into the file. (Note: no space between "+" sign and number) <P>
397
<DD> Display all files and directories, including those beginning
398
with a period (.). <P>
402
<DD> Enable the option to Replace text matches found using the
403
"Where is" command. <P>
407
<DD> Rebind the "delete" key so the character the cursor is on is rubbed
408
out rather than the character to its left. <P>
412
<DD>Enable file name completion. <P>
416
<DD> Use function keys for commands. <I>This option supported only in
417
conjunction with UW Enhanced NCSA telnet.</I> <P>
421
<DD> Enable "Show Cursor" mode in file browser. Cause cursor to be
422
positioned before the current selection rather than placed at the lower
423
left of the display. <P>
427
<DD>Causes "Cut Text" command to remove characters from the cursor
428
position to the end of the line rather than remove the entire line. <P>
432
<DD> Enable mouse functionality. This only works when <EM>Pico</EM> is
433
run from within an X Window System "xterm" window. <P>
437
<DD> The -n<EM>n</EM> option enables new mail notification. The
438
<EM>n</EM> argument is optional, and specifies how often, in seconds, your
439
mailbox is checked for new mail. For example, -n60 causes <EM>Pico</EM>
440
to check for new mail once every minute. The default interval is 180
441
seconds, while the minimum allowed is 30. (Note: no space between "n" and
446
<DD> Sets operating directory. Only files within this directory are
447
accessible. Likewise, the file browser is limited to the specified
448
directory subtree. <P>
452
<DD> Preserve the "start" and "stop" characters, typically Ctrl-Q
453
and Ctrl-S, which are sometimes used in communications paths to control data flow
454
between devices that operate at different speeds.<P>
458
<DD> TermdefWins. Termcap or terminfo escape sequences are used in preference
459
to default escape sequences.<P>
461
<DT> -Q <EM>quotestr</EM>
463
<DD> Set the quote string. Especially useful when composing email, setting this
464
allows the quote string to be checked for when Justifying paragraphs.
465
A common quote string is "> ".<P>
469
<DD> Sets column used to limit the "Justify" command's right margin. <P>
473
<DD> Enable "tool" mode. Intended for when <EM>Pico</EM> is used as the
474
editor within other tools (e.g., Elm, Pnews). <EM>Pico</EM> will not
475
prompt for save on exit, and will not rename the buffer during the "Write
480
<DD> View the file only, disallowing any editing. <P>
484
<DD> Print version information. <P>
488
<DD> Disable word wrap (thus allow editing of long lines). <P>
490
<I>Note: <EM>Pico</EM> will break any lines over 255 characters when reading a
491
file, regardless of word wrapping.</I> <P>
495
<DD> Disable keymenu at the bottom of the screen. <P>
499
<DD> Enable ^Z suspension of <EM>Pico</EM>. <P>
503
<H2><A NAME="pilot">Pilot</A></H2>
505
The following command line options are supported in <EM>Pilot</EM>:
511
<DD> Display all files including those beginning with a period (.). <P>
515
<DD> Use function keys for commands. <I>This option supported only in
516
conjunction with UW Enhanced NCSA telnet.</I> <P>
520
<DD> Enable "Show Cursor" mode. Cause cursor to be positioned before the
521
current selection rather than placed at the lower left of the display. <P>
525
<DD> Enable mouse functionality. This only works when <EM>Pilot</EM> is
526
run from within an X Window System "xterm" window. <P>
530
<DD> The -n<EM>n</EM> option enables new mail notification. The
531
<EM>n</EM> argument is optional, and specifies how often, in seconds, your
532
mailbox is checked for new mail. For example, -n60 causes <EM>Pilot</EM>
533
to check for new mail once every minute. The default interval is 180
534
seconds, while the minimum allowed is 30. (Note: no space between "n" and
539
<DD>Sets operating directory. Only files within the specified directory
540
are accessible and browsing is limited to the specified directory subtree.
545
<DD> Enable single vertical column display. <P>
549
<DD> Disable keymenu at the bottom of the screen. <P>
553
<DD> Enable ^Z suspension of <EM>Pilot</EM>.
added
removed
doc/tech-notes/cmd-line.html
