566 lines
7.6 KiB
HTML
566 lines
7.6 KiB
HTML
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Help</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="PREVIOUS"
|
|
TITLE="Virtual Terminals and screen"
|
|
HREF="x2005.htm"><LINK
|
|
REL="NEXT"
|
|
TITLE="Directing Input/Output"
|
|
HREF="c2269.htm"></HEAD
|
|
><BODY
|
|
CLASS="CHAPTER"
|
|
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="x2005.htm"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
></TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="c2269.htm"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="CHAPTER"
|
|
><H1
|
|
><A
|
|
NAME="HELP"
|
|
></A
|
|
>Chapter 5. Help</H1
|
|
><P
|
|
>The help <A
|
|
NAME="AEN2089"
|
|
></A
|
|
>chapter provides <A
|
|
NAME="AEN2091"
|
|
></A
|
|
>information on how you may access the documentation<A
|
|
NAME="AEN2093"
|
|
></A
|
|
> of the GNU/Linux system. There is normally a document <A
|
|
NAME="AEN2095"
|
|
></A
|
|
>describing every single tool you have installed,<A
|
|
NAME="AEN2097"
|
|
></A
|
|
> even if its only brief...</P
|
|
><P
|
|
></P
|
|
><DIV
|
|
CLASS="VARIABLELIST"
|
|
><DL
|
|
><DT
|
|
>man</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2104"
|
|
></A
|
|
>This command displays summary <A
|
|
NAME="AEN2106"
|
|
></A
|
|
>information <A
|
|
NAME="AEN2108"
|
|
></A
|
|
>on a program from an online<A
|
|
NAME="AEN2110"
|
|
></A
|
|
> manual.<A
|
|
NAME="AEN2112"
|
|
></A
|
|
> For example typing <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>man man </I
|
|
></SPAN
|
|
>will bring up the manual <A
|
|
NAME="AEN2115"
|
|
></A
|
|
>page for man (the manual <A
|
|
NAME="AEN2117"
|
|
></A
|
|
>page viewer). Note: q is the quit <A
|
|
NAME="AEN2119"
|
|
></A
|
|
>key.</P
|
|
><P
|
|
>Command syntax:</P
|
|
><PRE
|
|
CLASS="SCREEN"
|
|
>man program_name</PRE
|
|
><DIV
|
|
CLASS="TIP"
|
|
><BLOCKQUOTE
|
|
CLASS="TIP"
|
|
><P
|
|
><B
|
|
>Also try: </B
|
|
>Specifying the section of the manual page, sometimes the man page is different for the same tool in different sections, note sections are numbered 1 to 9. Use apropos to find which section number to look in.</P
|
|
><P
|
|
>The syntax to look at a different section is:
|
|
<PRE
|
|
CLASS="SCREEN"
|
|
>man section_number tool_name</PRE
|
|
>
|
|
For example:
|
|
<PRE
|
|
CLASS="SCREEN"
|
|
>man 2 time</PRE
|
|
>
|
|
This will show you the man page called time in section 2, the equivalent page in section 1 is completely different</P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
></DD
|
|
><DT
|
|
>man -K keyword</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2133"
|
|
></A
|
|
>Search the manual <A
|
|
NAME="AEN2135"
|
|
></A
|
|
>pages for a string,<A
|
|
NAME="AEN2137"
|
|
></A
|
|
> as in it will search<A
|
|
NAME="AEN2139"
|
|
></A
|
|
> all manual <A
|
|
NAME="AEN2141"
|
|
></A
|
|
>pages for a particular string within each individual <A
|
|
NAME="AEN2143"
|
|
></A
|
|
>man page, it will then prompt <A
|
|
NAME="AEN2145"
|
|
></A
|
|
>whether you would like to view <A
|
|
NAME="AEN2147"
|
|
></A
|
|
>each page it will find. Use double <A
|
|
NAME="AEN2149"
|
|
></A
|
|
>quotes “ and ” if there are spaces <A
|
|
NAME="AEN2151"
|
|
></A
|
|
>in the string you are typing.</P
|
|
><DIV
|
|
CLASS="CAUTION"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="CAUTION"
|
|
BORDER="1"
|
|
WIDTH="90%"
|
|
><TR
|
|
><TD
|
|
ALIGN="CENTER"
|
|
><B
|
|
>Speed issue</B
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
ALIGN="LEFT"
|
|
><P
|
|
> Please be warned that this method is going to be really, really slow. You are searching *all* man pages for a string </P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></DD
|
|
><DT
|
|
>man -f command</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2160"
|
|
></A
|
|
>This will list <A
|
|
NAME="AEN2162"
|
|
></A
|
|
>details <A
|
|
NAME="AEN2164"
|
|
></A
|
|
>associated <A
|
|
NAME="AEN2166"
|
|
></A
|
|
>with the command. The root <A
|
|
NAME="AEN2168"
|
|
></A
|
|
>user must run <A
|
|
NAME="AEN2170"
|
|
></A
|
|
><SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>makewhatis</I
|
|
></SPAN
|
|
> <A
|
|
NAME="AEN2173"
|
|
></A
|
|
>(see below) before this command will work. </P
|
|
><DIV
|
|
CLASS="NOTE"
|
|
><BLOCKQUOTE
|
|
CLASS="NOTE"
|
|
><P
|
|
><B
|
|
>Equivalent to <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
>: </B
|
|
> This command is the same as running <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
></P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
></DD
|
|
><DT
|
|
>info</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2184"
|
|
></A
|
|
>Provides a more detailed <A
|
|
NAME="AEN2186"
|
|
></A
|
|
>hyper-text manual <A
|
|
NAME="AEN2188"
|
|
></A
|
|
>on a particular command, this only works for some commands.</P
|
|
><P
|
|
>Command syntax:</P
|
|
><PRE
|
|
CLASS="SCREEN"
|
|
>info program_name</PRE
|
|
></DD
|
|
><DT
|
|
>whatis</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2196"
|
|
></A
|
|
>Displays a one-line description <A
|
|
NAME="AEN2198"
|
|
></A
|
|
>of what a program <A
|
|
NAME="AEN2200"
|
|
></A
|
|
>does. The string needs to be an exact <A
|
|
NAME="AEN2202"
|
|
></A
|
|
>match, otherwise <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
> won't output <A
|
|
NAME="AEN2205"
|
|
></A
|
|
>anything. Relies on the whatis database (see below).</P
|
|
><P
|
|
>Command syntax:</P
|
|
><PRE
|
|
CLASS="SCREEN"
|
|
>whatis program_name</PRE
|
|
></DD
|
|
><DT
|
|
>makewhatis</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2213"
|
|
></A
|
|
>Make the whatis database for <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>apropos</I
|
|
></SPAN
|
|
>, <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
> and<SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
> man -f.<A
|
|
NAME="AEN2218"
|
|
></A
|
|
></I
|
|
></SPAN
|
|
> </P
|
|
><DIV
|
|
CLASS="NOTE"
|
|
><BLOCKQUOTE
|
|
CLASS="NOTE"
|
|
><P
|
|
><B
|
|
>Root Privileges: </B
|
|
>This takes some time and you require root privileges to do this.</P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
></DD
|
|
><DT
|
|
>apropos</DT
|
|
><DD
|
|
><P
|
|
><A
|
|
NAME="AEN2227"
|
|
></A
|
|
>Searches <A
|
|
NAME="AEN2229"
|
|
></A
|
|
>the whatis database for strings,<A
|
|
NAME="AEN2231"
|
|
></A
|
|
> similar to <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
> except it finds <A
|
|
NAME="AEN2234"
|
|
></A
|
|
>and prints <A
|
|
NAME="AEN2236"
|
|
></A
|
|
>anything matching <A
|
|
NAME="AEN2238"
|
|
></A
|
|
>the string (or any part of the string). Also relies on the whatis database (see above). </P
|
|
><P
|
|
>Command syntax:</P
|
|
><PRE
|
|
CLASS="SCREEN"
|
|
>apropos string</PRE
|
|
><DIV
|
|
CLASS="NOTE"
|
|
><BLOCKQUOTE
|
|
CLASS="NOTE"
|
|
><P
|
|
><B
|
|
>Equivalent to...: </B
|
|
> <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>apropos</I
|
|
></SPAN
|
|
> is the same as doing <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>man -k</I
|
|
></SPAN
|
|
> (lowercase k).</P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
><DIV
|
|
CLASS="NOTE"
|
|
><BLOCKQUOTE
|
|
CLASS="NOTE"
|
|
><P
|
|
><B
|
|
>Please note: </B
|
|
>You need to run <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>makewhatis</I
|
|
></SPAN
|
|
> (as root) so <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>whatis</I
|
|
></SPAN
|
|
>, <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>man -f </I
|
|
></SPAN
|
|
>and <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>apropos </I
|
|
></SPAN
|
|
>will work.</P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
><DIV
|
|
CLASS="TIP"
|
|
><BLOCKQUOTE
|
|
CLASS="TIP"
|
|
><P
|
|
><B
|
|
>Also try: </B
|
|
>Using a program with the <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>-?</I
|
|
></SPAN
|
|
>,<A
|
|
NAME="AEN2258"
|
|
></A
|
|
> <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>--h</I
|
|
></SPAN
|
|
>,<A
|
|
NAME="AEN2261"
|
|
></A
|
|
> <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>--help</I
|
|
></SPAN
|
|
><A
|
|
NAME="AEN2264"
|
|
></A
|
|
>, and the <SPAN
|
|
CLASS="emphasis"
|
|
><I
|
|
CLASS="EMPHASIS"
|
|
>-h<A
|
|
NAME="AEN2267"
|
|
></A
|
|
></I
|
|
></SPAN
|
|
> options, they will display very short summary information on the command usage options.</P
|
|
></BLOCKQUOTE
|
|
></DIV
|
|
></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="x2005.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="c2269.htm"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>Virtual Terminals and screen</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Directing Input/Output</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |