old-www/LDP/GNU-Linux-Tools-Summary/html/x392.htm

602 lines
8.1 KiB
HTML

<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="book1.htm"><LINK
REL="UP"
TITLE="Introduction"
HREF="c107.htm"><LINK
REL="PREVIOUS"
TITLE="Availability of sources"
HREF="x335.htm"><LINK
REL="NEXT"
TITLE="Resources used to create this document "
HREF="x611.htm"></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="x335.htm"
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="x611.htm"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONVENTIONS"
></A
>Conventions used in this guide</H1
><P
>The following conventions <A
NAME="AEN395"
></A
>are used within this guide:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>italic</DT
><DD
><P
><A
NAME="AEN402"
></A
>Anything appearing in italic, <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>like&nbsp;this </I
></SPAN
>is either an executable <A
NAME="AEN405"
></A
>command or emphasized <A
NAME="AEN407"
></A
>text. Tools (executable commands) are in italics <A
NAME="AEN409"
></A
>to prevent confusion. Some tools have names which are real english <A
NAME="AEN411"
></A
>words, such as the &ldquo;locate&rdquo; tool.</P
></DD
><DT
>key&nbsp;combinations</DT
><DD
><P
><A
NAME="AEN417"
></A
>Are represented by using a '-' (dash sign)<A
NAME="AEN419"
></A
> in-between the key(s), which must be used in combination.<A
NAME="AEN421"
></A
> All combinations <A
NAME="AEN423"
></A
>are also printed <A
NAME="AEN425"
></A
>in italics <A
NAME="AEN427"
></A
>to improve clarity.<A
NAME="AEN429"
></A
> For example
<B
CLASS="KEYCAP"
>CTRL</B
>-<B
CLASS="KEYCAP"
>Z</B
>
<A
NAME="AEN434"
></A
>
means hold down the<SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
> Control key<A
NAME="AEN437"
></A
></I
></SPAN
> and press the <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>z</I
></SPAN
> <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>key.</I
></SPAN
></P
></DD
><DT
>admonitions</DT
><DD
><P
><A
NAME="AEN445"
></A
>Admonitions are little pictures <A
NAME="AEN447"
></A
>used to emphasize <A
NAME="AEN449"
></A
>something of importance <A
NAME="AEN451"
></A
>to the reader.<A
NAME="AEN453"
></A
> </P
><P
>The five types used are:</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>This is a note: </B
>
Notes often give important information about a tool.</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="TIP"
><BLOCKQUOTE
CLASS="TIP"
><P
><B
>This is a tip: </B
>
This will offer a useful switch or useful way to use a tool.</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="IMPORTANT"
><BLOCKQUOTE
CLASS="IMPORTANT"
><P
><B
>This is something important: </B
>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
></BLOCKQUOTE
></DIV
><DIV
CLASS="CAUTION"
><P
></P
><TABLE
CLASS="CAUTION"
BORDER="1"
WIDTH="90%"
><TR
><TD
ALIGN="CENTER"
><B
>This is a caution</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><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"
BORDER="1"
WIDTH="90%"
><TR
><TD
ALIGN="CENTER"
><B
>This is a warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><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&nbsp;examples</DT
><DD
><P
>Code <A
NAME="AEN475"
></A
>examples <A
NAME="AEN477"
></A
>are shown for most commands. </P
><P
>Below is an example of what code <A
NAME="AEN480"
></A
>looks like:</P
><PRE
CLASS="SCREEN"
>Hello World, I'm a code example. :)</PRE
></DD
><DT
>command&nbsp;syntax</DT
><DD
><P
><A
NAME="AEN487"
></A
>(or a similar phrase) simply shows how you would normally use the command. Often real examples <A
NAME="AEN489"
></A
>are used instead of explaining <A
NAME="AEN491"
></A
>the command syntax. </P
><P
>The phrase &ldquo; Command syntax&rdquo; is always followed by the way you would type a command in a shell.<A
NAME="AEN494"
></A
></P
><P
>The standard <A
NAME="AEN497"
></A
>syntax <A
NAME="AEN499"
></A
>for any tool is usually:</P
><PRE
CLASS="SCREEN"
>command -options file</PRE
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Note that some tools do not accept options.</P
></BLOCKQUOTE
></DIV
></DD
><DT
>wildcards</DT
><DD
><P
><A
NAME="AEN509"
></A
>Also note that most commands, even when not explicitly <A
NAME="AEN511"
></A
>stated, will work with standard wildcards <A
NAME="AEN513"
></A
> (or globbing patterns<A
NAME="AEN515"
></A
>) such as *, [A-Z] and various other standard wildcards. Refer <A
NAME="AEN517"
></A
>to <A
HREF="x11655.htm#STANDARD-WILDCARDS"
>the Section called <I
>Standard Wildcards (globbing patterns)</I
> in Chapter 20</A
> for further information.</P
></DD
><DT
>access&nbsp;keys</DT
><DD
><P
><A
NAME="AEN524"
></A
>Access keys enable <A
NAME="AEN526"
></A
>navigation through the document, without relying on a mouse.<A
NAME="AEN528"
></A
> The following keys have been given special <A
NAME="AEN530"
></A
>meaning in this document:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>P</DT
><DD
><P
>Previous <A
NAME="AEN537"
></A
>page.<A
NAME="AEN539"
></A
></P
></DD
><DT
>N</DT
><DD
><P
>Next <A
NAME="AEN545"
></A
>page.</P
></DD
><DT
>H</DT
><DD
><P
>Home <A
NAME="AEN551"
></A
>of the document (Table of Contents).<A
NAME="AEN553"
></A
></P
></DD
><DT
>U</DT
><DD
><P
>Up<A
NAME="AEN559"
></A
> (takes you one level <A
NAME="AEN561"
></A
>up the section <A
NAME="AEN563"
></A
>hierarchy).</P
></DD
></DL
></DIV
><P
>If you also happen to be reading <A
NAME="AEN566"
></A
>the document from its original <A
NAME="AEN568"
></A
>location, then the following access keys can also be used:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>S</DT
><DD
><P
>Start <A
NAME="AEN575"
></A
>(takes you to the author's start page).</P
></DD
><DT
>T</DT
><DD
><P
>The current <A
NAME="AEN581"
></A
>(&ldquo;This&rdquo;) page, without the Sitemenu <A
NAME="AEN583"
></A
>on the left.</P
></DD
><DT
>M</DT
><DD
><P
>The current page in a frameset,<A
NAME="AEN589"
></A
> where the left frame <A
NAME="AEN591"
></A
>contains a Menu.<A
NAME="AEN593"
></A
></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="x335.htm"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.htm"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x611.htm"
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="c107.htm"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Resources used to create this document</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>