Conventions in this document
Prev     Next

Conventions in this document

  1. This is the first step.

    Take this action.

  2. This is the next step.

    Take this action.

    Note

    This is optional information.

  3. This step could be risky.

    Take this precautionary step.

    Warning

    This is the warning.

  4. This step includes entering text.

    Input this text. This is what you type, or copy and paste.

    Note

    $ is the default prompt for the bash shell. Input this text directly into a shell where you are logged in as normal user. You can copy and paste this text—the $ won't be copied.

  5. This step includes a root command.

    sudo This is a command that requires root permission

    Note

    This is a command you type or paste with the authority of the root user. These commands all start with sudo, so you don't need to run them as the root user, as long as you run them from an account with sudo permission.

    Note

    Note for editors: as a hack, use userinput for regular input and prompt for root commands.

  6. This is system output:

    Power save: off

    Note

    This is a command you type or paste with the authority of the root user. These commands all start with sudo, so you don't need to run them as the root user, as long as you run them from an account with sudo permission.

  7. This step includes a customizable input

    Replace NAME with your username. example-code-set-name NAME

    Note

    The text you will replace looks like this: replace me. It should be in italics and may be slowly blinking.

  8. This step copies a configuration file

    cp /source/configfile ~/.config/

    Note

    When the instructions call for copying a text configuration file, the contents of the file are also listed in full here in the instructions. 

    This is a file listing.
              
It could be several lines line or a hundred.
It's the same thing as the source file in the instruction, as a backup.


It could have really long lines that might end up getting truncated on display, but they will all be present if copied.

Procedure 1. Style Guide