old-www/LDP/GNU-Linux-Tools-Summary/html/conventions.html

575 lines
8.3 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>Conventions used in this guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="GNU/Linux Command-Line Tools Summary"
HREF="index.html"><LINK
REL="UP"
TITLE="Introduction"
HREF="introduction.html"><LINK
REL="PREVIOUS"
TITLE="Availability of sources"
HREF="sources-of-document.html"><LINK
REL="NEXT"
TITLE="Resources used to create this document "
HREF="resources-used-to-create-this-document.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>GNU/Linux Command-Line Tools Summary</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sources-of-document.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 1. Introduction</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="resources-used-to-create-this-document.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONVENTIONS"
></A
>1.4. Conventions used in this guide</H1
><P
>The following conventions are used within this guide:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>italic</DT
><DD
><P
>Anything appearing in italic, <EM
>like this </EM
>is either an executable command or emphasized text. Tools (executable commands) are in italics to prevent confusion. Some tools have names which are real english words, such as the &#8220;locate&#8221; tool.</P
></DD
><DT
>key combinations</DT
><DD
><P
>Are represented by using a '-' (dash sign) in-between the key(s), which must be used in combination. All combinations are also printed in italics to improve clarity. For example
<B
CLASS="KEYCAP"
>CTRL</B
>-<B
CLASS="KEYCAP"
>Z</B
>
means hold down the<EM
> Control key</EM
> and press the <EM
>z</EM
> <EM
>key.</EM
></P
></DD
><DT
>admonitions</DT
><DD
><P
>Admonitions are little pictures used to emphasize something of importance to the reader. </P
><P
>The five types used are:</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>This is a note</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>
Notes often give important information about a tool.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="TIP"
><P
></P
><TABLE
CLASS="TIP"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>This is a tip</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>
This will offer a useful switch or useful way to use a tool.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="IMPORTANT"
><P
></P
><TABLE
CLASS="IMPORTANT"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/important.gif"
HSPACE="5"
ALT="Important"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>This is something important</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>This is something that is considered very important. Consider it like a note with extra importance, they are usually there to save the reader time.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/caution.gif"
HSPACE="5"
ALT="Caution"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>This is a caution</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>
This will inform you of something that you be careful about (because it could be harmful to your system).</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>This is a warning</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>
This will inform you of something that you shouldn't do (because it probably will break something within your system).</P
></TD
></TR
></TABLE
></DIV
></DD
><DT
>code examples</DT
><DD
><P
>Code examples are shown for most commands. </P
><P
>Below is an example of what code looks like:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
>Hello World, I'm a code example. :)</PRE
></FONT
></TD
></TR
></TABLE
></DD
><DT
>command syntax</DT
><DD
><P
>(or a similar phrase) simply shows how you would normally use the command. Often real examples are used instead of explaining the command syntax. </P
><P
>The phrase &#8220; Command syntax&#8221; is always followed by the way you would type a command in a shell.</P
><P
>The standard syntax for any tool is usually:</P
><TABLE
BORDER="1"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="SCREEN"
>command -options file</PRE
></FONT
></TD
></TR
></TABLE
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="90%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>Note</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Note that some tools do not accept options.</P
></TD
></TR
></TABLE
></DIV
></DD
><DT
>wildcards</DT
><DD
><P
>Also note that most commands, even when not explicitly stated, will work with standard wildcards (or globbing patterns) such as *, [A-Z] and various other standard wildcards. Refer to <A
HREF="wildcards.html#STANDARD-WILDCARDS"
>Section 20.4.1</A
> for further information.</P
></DD
><DT
>access keys</DT
><DD
><P
>Access keys enable navigation through the document, without relying on a mouse. The following keys have been given special meaning in this document:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>P</DT
><DD
><P
>Previous page.</P
></DD
><DT
>N</DT
><DD
><P
>Next page.</P
></DD
><DT
>H</DT
><DD
><P
>Home of the document (Table of Contents).</P
></DD
><DT
>U</DT
><DD
><P
>Up (takes you one level up the section hierarchy).</P
></DD
></DL
></DIV
><P
>If you also happen to be reading the document from its original location, then the following access keys can also be used:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>S</DT
><DD
><P
>Start (takes you to the author's start page).</P
></DD
><DT
>T</DT
><DD
><P
>The current (&#8220;This&#8221;) page, without the Sitemenu on the left.</P
></DD
><DT
>M</DT
><DD
><P
>The current page in a frameset, where the left frame contains a Menu.</P
></DD
></DL
></DIV
></DD
></DL
></DIV
><P
>To use the access keys, you have to simultaneously press a modifier key, which may vary from browser to browser. For example in NN6+/Mozilla, the modifier key is <B
CLASS="KEYCAP"
>ALT</B
>, so you have to use
<B
CLASS="KEYCAP"
>ALT</B
>-<B
CLASS="KEYCAP"
>N</B
>
to go to the next page, and
<B
CLASS="KEYCAP"
>ALT</B
>-<B
CLASS="KEYCAP"
>P</B
>
to come back. In other browsers such as IE6, the access keys just give focus to the associated link, so the sequence becomes
<B
CLASS="KEYCAP"
>ALT</B
>-<B
CLASS="KEYCAP"
>N</B
> <B
CLASS="KEYCAP"
>Enter</B
>
. Try it, you'll like it! <SPAN
CLASS="INLINEMEDIAOBJECT"
><DIV
CLASS="TEXTOBJECT"
><SPAN
CLASS="phrase"
><SPAN
CLASS="PHRASE"
>Inline graphic</SPAN
></SPAN
></DIV
></SPAN
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sources-of-document.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="resources-used-to-create-this-document.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Availability of sources</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="introduction.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Resources used to create this document</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>