Filter
Top Products
Preface About This Guide 17
Parameters You Must Enter as Shown
If you must enter a parameter as shown, it appears following the command in the
same font. For example:
$ doit -w later -t 12:30
To use the command in this example, enter the entire line as shown (without the $ and
space).
Parameter Values You Provide
If you must provide a value, its placeholder is italicized and has a name that indicates
what you need to provide. For example:
$ doit -w later -t
hh
:
mm
In this example, you replace
hh
with the hour and
mm
with the minute, as shown in the
previous example.
Optional Parameters
If a parameter is not required, it appears in square brackets. For example:
$ doit [-w later]
To use the command in this example, enter either doit or doit -w later. The result
might vary, but the command will be performed either way.
Alternative Parameters
If you must enter one of a number of parameters, they’re separated by a vertical line
and grouped within parentheses (|). For example:
$ doit -w (now|later)
To perform this command, enter either doit -w now or doit -w later.
Default Settings
Descriptions of server settings usually include the default value for each setting. When
this default value depends on your configuration (such as the name or IP address of
your server), it’s enclosed in angle brackets.
For example, the default value for the IMAP mail server is the host name of your server.
This is indicated by mail:imap:servername = "<hostname>".
Commands Requiring Root Privileges
Throughout this manual, commands that require root privileges begin with sudo. See
“Commands Requiring Root Privileges” on page 26.