mod_perl2 User's Guide
By Stas Bekman, Jim Brandt
By Stas Bekman, Eric Cholet
We use a number of conventions in this documentation, that are mostly easy to understand; if you're in doubt, look here for the explanation.
For commands that should be typed in your shell (or your Command prompt, or whatever your OS calls it), we use the following prompts:
% ls -l
for the user-mode prompt (ie. a normal user account, with no special privileges).
# ls -l
for the superuser prompt: this means you'll have to change users to
become the super user on your platform. On Unix you can use the
sudo utilities to gain superuser privileges (provided you know
the root password); on other platforms you might have to change the
user -- to Administrator for example on Windows.
If you cannot obtain super user privileges, there will often be explanations about how doing the selected task without those privileges; in any other case, contact your system administrator.
On documents specific to a certain Operating System, the prompt might change. For example, in Windows documentation, we might use:
instead of any other prompt.
We try to be consistent about our use of different fonts and faces, so that you'll recognize special words more easily.
Use F<filename> for filenames, directories/paths, URIs, and the like.
Use I<italics> for emphasizing things. But use them with care, when things really need to be emphasized.
Use B<stress> for stressing things more strongly than I<italics> does. But avoid using this tag unless you think things are very important. Defer to I<italics> for emphasis, instead. Over-use of bold text reduces its original intention -- so use it with care to really make things stand out when they need to stand out.
Use C<Constant width> for commands/program names, configuration items or Perl code/function names, and manpage references.
is used for things we want to stress.