Sample How To Template

Replace this heading with the title of this How To procedure. Specifically identify the procedure you are documenting, such as installation and configuration instructions, tutorials, or troubleshooting procedures. For example:

How to Install and Configure Skype on the OpenSolaris OS
How to Display a List of Disks on a Server
How to Set Up Print Manager to Detect Networked Printers

Add an introductory sentence or two. For example:

If no wired interface connection is detected at system startup, NWAM automatically tries to connect to an available wireless network at the system's physical location. If NWAM discovers more than one wireless network at the current location, you are prompted to select a network.

Before You Begin

Use this heading to introduce a bulleted list to show any prerequisites the user needs to consider to complete the procedure. For example:

To complete this procedure, you need:

A local copy of the installation file
The registration number for the software
Superuser access to the server

Steps

Remove this heading and start a numbered list to describe steps to complete the procedure. Present the steps in the order that the user needs to complete them. Make each step short and equivalent to one action. Tell the user what to expect after each step. (For more guidelines on writing procedures, see the Editorial Cheat Sheet for OpenSolaris Documentation .) For example:

Click the NWAM Manager Icon.
You see a menu with the following:
- Current automatic network interface selection, which is "wireless."
- Name, or ESSID, of each wireless network. If the network's operational mode is ad hoc, its name is followed by the legend (Computer-to-Computer). For information about ESSIDs and ad hoc networks, refer to How to Obtain Detailed Information About the Active Network Connection.
- Bars that indicate that network's current strength.
Click the wireless network of your choice.
- If you connect to a public network, you receive status information for that network.
- If you connect to a private network, you are prompted for a password.

Note
To make sure the steps numbers don't reset, add

\\

to all blank lines in between the steps.

Displaying Code in Steps

Use the code macro to display code or command-line user input in the steps.

For example, the following wiki syntax creates the subsequent output.

{code}
# ls -l <directory>
{code}

# ls -l <directory>

Use angle brackes < > to indicate variables.

Displaying pfexec Step

In a lot of administrative procedures, running pfexec is a required step. There is an include that will produce this for you. For example, the following wiki syntax creates the subsequent output.

# {include:root_step}

Start a privileged shell.
```
user@opensolaris:-$ pfexec bash
#
```
In this example, the bash shell is selected. You can choose to use any shell with the pfexec command. If you support multiple versions of the Solaris^TM OS, use the standard su – root command. The su command works on all Solaris versions.

Notes

An optional element. Add notes / tips where appropriate to help the user through difficult procedure or to give extra information that provides context for an action. For example:

Note
The Z software needs the configuration file only during its system detection phase, so you can remove the file when the system detection is complete.

Cautions

An optional element. Add cautions under the following circumstances:

When you describe a situation that has the potential to cause injury to a person, or when there is a risk of irreversible destruction to data or the operating system
When you describe anything that has the potential to cause damage to equipment, data, or software
For example:

Caution
If you accidentally type the crontab command with no option, press the interrupt character for your editor to quit without saving changes. If you instead save changes and exit the file, the existing crontab file is overwritten with an empty file.

Examples

An optional element. Add examples where appropriate to help the user through difficult procedure. For example:

Example

Use this macro to add examples where warranted.