mod_perl logo perl icon
no previous pagepage up: Documentationnext page: mod_perl 1.0 Documentation

Conventions used in the mod_perl Documentation






mod_perl Pocket Reference

mod_perl Pocket Reference

By Andrew Ford
Writing Apache Modules with Perl and C

Writing Apache Modules with Perl and C

By Lincoln Stein, Doug MacEachern
Embedding Perl in HTML with Mason

Embedding Perl in HTML with Mason

By Dave Rolsky, Ken Williams
mod_perl2 User's Guide

mod_perl2 User's Guide

By Stas Bekman, Jim Brandt
Practical mod_perl

Practical mod_perl

By Stas Bekman, Eric Cholet
The mod_perl Developer's Cookbook

The mod_perl Developer's Cookbook

By Geoffrey Young, Paul Lindner, Randy Kobes


Table of Contents

Description

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.



TOP

Prompts

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 su or 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:

  C:\> nmake

instead of any other prompt.



TOP

Typographical conventions

We try to be consistent about our use of different fonts and faces, so that you'll recognize special words more easily.






TOP
no previous pagepage up: Documentationnext page: mod_perl 1.0 Documentation