markup
authormatthias <matthias@web>
Wed, 18 Feb 2009 18:15:21 +0000 (10:15 -0800)
committerCharlie <root@leaf.dragonflybsd.org>
Wed, 18 Feb 2009 18:15:21 +0000 (10:15 -0800)
docs/handbook/handbook-basics-more-information.mdwn

index ae7b309..41f22f0 100644 (file)
@@ -1,78 +1,67 @@
-\r
-\r
-## 3.13 For More Information \r
-\r
-### 3.13.1 Manual Pages \r
-\r
-The most comprehensive documentation on DragonFly is in the form of manual pages. Nearly every program on the system comes with a short reference manual explaining the basic operation and various arguments. These manuals can be viewed with the `man` command. Use of the `man` command is simple:\r
-\r
-    \r
-    % man command\r
-\r
-\r
-`command` is the name of the command you wish to learn about. For example, to learn more about `ls` command type:\r
-\r
-    \r
-    % man ls\r
-\r
-\r
-The online manual is divided up into numbered sections:\r
-\r
-  1. User commands.\r
-  1. System calls and error numbers.\r
-  1. Functions in the C libraries.\r
-  1. Device drivers.\r
-  1. File formats.\r
-  1. Games and other diversions.\r
-  1. Miscellaneous information.\r
-  1. System maintenance and operation commands.\r
-  1. Kernel internals.\r
-\r
-In some cases, the same topic may appear in more than one section of the online manual. For example, there is a `chmod` user command and a `chmod()` system call. In this case, you can tell the `man` command which one you want by specifying the section:\r
-\r
-    \r
-    % man 1 chmod\r
-\r
-\r
-This will display the manual page for the user command `chmod`. References to a particular section of the online manual are traditionally placed in parenthesis in written documentation, so [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#chmod&section1) refers to the `chmod` user command and [chmod(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section=2) refers to the system call.\r
-\r
-This is fine if you know the name of the command and simply wish to know how to use it, but what if you cannot recall the command name? You can use `man` to search for keywords in the command descriptions by using the `-k` switch:\r
-\r
-    \r
-    % man -k mail\r
-\r
-\r
-With this command you will be presented with a list of commands that have the keyword ***mail*** in their descriptions. This is actually functionally equivalent to using the `apropos` command.\r
-\r
-So, you are looking at all those fancy commands in `/usr/bin` but do not have the faintest idea what most of them actually do? Simply do:\r
-\r
-    \r
-    % cd /usr/bin\r
-    % man -f *\r
-\r
-\r
-or\r
-\r
-    \r
-    % cd /usr/bin\r
-    % whatis *\r
-\r
-\r
-which does the same thing.\r
-\r
-### 3.13.2 GNU Info Files \r
-\r
-DragonFly includes many applications and utilities produced by the Free Software Foundation (FSF). In addition to manual pages, these programs come with more extensive hypertext documents called `info` files which can be viewed with the `info` command or, if you installed  **emacs** , the info mode of  **emacs** .\r
-\r
-To use the [info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#info&section1) command, simply type:\r
-\r
-    \r
-    % info\r
-\r
-\r
-For a brief introduction, type `h`. For a quick command reference, type `?`.\r
-\r
-\r
-\r
-CategoryHandbook\r
-CategoryHandbook-basics\r
+## For More Information 
+
+### Manual Pages 
+
+The most comprehensive documentation on DragonFly is in the form of manual pages. Nearly every program on the system comes with a short reference manual explaining the basic operation and various arguments. These manuals can be viewed with the `man` command. Use of the `man` command is simple:
+
+    % man command
+
+`command` is the name of the command you wish to learn about. For example, to learn more about `ls` command type:
+
+    % man ls
+
+The online manual is divided up into numbered sections:
+
+
+  1. User commands.
+  1. System calls and error numbers.
+  1. Functions in the C libraries.
+  1. Device drivers.
+  1. File formats.
+  1. Games and other diversions.
+  1. Miscellaneous information.
+  1. System maintenance and operation commands.
+  1. Kernel internals.
+
+
+
+In some cases, the same topic may appear in more than one section of the online manual. For example, there is a `chmod` user command and a `chmod()` system call. In this case, you can tell the `man` command which one you want by specifying the section:
+    
+
+    % man 1 chmod
+
+
+This will display the manual page for the user command `chmod`. References to a particular section of the online manual are traditionally placed in parenthesis in written documentation, so [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#chmod&section1) refers to the `chmod` user command and [chmod(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section=2) refers to the system call.
+
+This is fine if you know the name of the command and simply wish to know how to use it, but what if you cannot recall the command name? You can use `man` to search for keywords in the command descriptions by using the `-k` switch:
+
+   
+
+    % man -k mail
+
+
+With this command you will be presented with a list of commands that have the keyword ***mail*** in their descriptions. This is actually functionally equivalent to using the `apropos` command.
+
+So, you are looking at all those fancy commands in `/usr/bin` but do not have the faintest idea what most of them actually do? Simply do:    
+
+    % cd /usr/bin
+    % man -f *
+
+or
+   
+
+    % cd /usr/bin
+    % whatis *
+
+which does the same thing.
+
+
+
+### GNU Info Files 
+
+DragonFly includes many applications and utilities produced by the Free Software Foundation (FSF). In addition to manual pages, these programs come with more extensive hypertext documents called `info` files which can be viewed with the `info` command or, if you installed  **emacs** , the info mode of  **emacs** . To use the [info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#info&section1) command, simply type:
+
+
+    % info
+
+For a brief introduction, type `h`. For a quick command reference, type `?`.