This manual uses a number of text and style conventions to indicate and differentiate between different types of information:
Text in this style is used to show emphasis of some kind.
Text in this style is used to show a section heading, table heading, or particularly important emphasis of some kind.
Program or configuration options are formatted using
Text in this style demonstrates the name of a command, utility or script.
Functions will always include the parentheses when appropriate,
Methods will include parentheses when appropriate for the
language, for example:
Text in this style indicates literal or
character sequence text used to show a specific value.
Filenames, directories or paths are shown like this
For values that you can specify or replace, the text will be
using this style .
Text or values that you should substitute with a specific
version or alternative are indicated using
Code listings are used to show sample programs, code, configuration files and other elements. These can include both user input and replaceable values:
In the above example command-lines to be entered into a shell are
shell. This shell is typically
sh, ksh, or
bash on Linux and Unix platforms, or
Cmd.exe or PowerShell on Windows.
If commands are to be executed using administrator privileges, each line will be prefixed with root-shell, for example:
root-shell> /etc/init.d/couchbase-server restart