Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
tutorials:findinghelp [2011/04/30 13:07] – created clemenstutorials:findinghelp [2012/05/01 20:48] (current) – Add $ID tag memnon
Line 1: Line 1:
 ====== Finding Help From Within the Shell ====== ====== Finding Help From Within the Shell ======
  
-Note: Please look [[#sdfspecific|further down]] about help facilities specific to SDF, like the FAQ!+Note: Please look [[#SDF specific help|further down]] about help facilities specific to SDF, like the FAQ!
  
 While the UNIX shell may seem a bit daunting and cold with cryptic two-letter commands, dozens of command line switches, and no animated paper clips to show you the way, there are several different ways of getting help from the system. While the UNIX shell may seem a bit daunting and cold with cryptic two-letter commands, dozens of command line switches, and no animated paper clips to show you the way, there are several different ways of getting help from the system.
Line 7: Line 7:
 ---- ----
  
-===== [[|Using Manpages]] =====+===== Using Manpages =====
  
 ==== The Definitive Guide to RTFMing ==== ==== The Definitive Guide to RTFMing ====
Line 15: Line 15:
 Where can you find them? It's pretty simple. Think of a command. (ls, rm, chmod, kill, grep) or a program (vi, mutt, snarf, majordomo) So go ahead, type Where can you find them? It's pretty simple. Think of a command. (ls, rm, chmod, kill, grep) or a program (vi, mutt, snarf, majordomo) So go ahead, type
  
-"% man //command//"+  * man //command//
  
 command being the name of the command you want to learn about. As you can see, manpages are broken down into sections. We'll use mkdir as an example. command being the name of the command you want to learn about. As you can see, manpages are broken down into sections. We'll use mkdir as an example.
  
-"% man mkdir"+<code> 
 +man mkdir
  
   MKDIR(1)                NetBSD General Commands Manual   MKDIR(1)                NetBSD General Commands Manual
Line 63: Line 64:
   NetBSD 2.0.2                   January 25, 1994                   NetBSD   NetBSD 2.0.2                   January 25, 1994                   NetBSD
   2.0.2   2.0.2
 +</code>
  
 For our "mkdir" command, the man page displayed has six sections: NAME, SYNOPSIS, DESCRIPTION, EXIT STATUS, SEE ALSO, and STANDARDS. The NAME section simply shows the name of the command and a terse description of its function. The SYNOPSIS gives a brief outline of the command syntax, so you can see what the command you enter should look like. Items in square brackets [ ] are optional. The DESCRIPTION section provides a detailed description of how the command works, including information on the various options or modes of the command. The EXIT STATUS section describes what status codes are generated by the command when it completes (successfully or unsuccessfully). These codes can be read by programs (such as a shell script) to determine how to react to the command's result. SEE ALSO provides cross referencing information for related commands or others which may be helpful. And finally, the STANDARDS section lists information on which standards this particular command complies with. For our "mkdir" command, the man page displayed has six sections: NAME, SYNOPSIS, DESCRIPTION, EXIT STATUS, SEE ALSO, and STANDARDS. The NAME section simply shows the name of the command and a terse description of its function. The SYNOPSIS gives a brief outline of the command syntax, so you can see what the command you enter should look like. Items in square brackets [ ] are optional. The DESCRIPTION section provides a detailed description of how the command works, including information on the various options or modes of the command. The EXIT STATUS section describes what status codes are generated by the command when it completes (successfully or unsuccessfully). These codes can be read by programs (such as a shell script) to determine how to react to the command's result. SEE ALSO provides cross referencing information for related commands or others which may be helpful. And finally, the STANDARDS section lists information on which standards this particular command complies with.
Line 80: Line 82:
 In some cases, the same topic will appear on more than one section of the manual. For example, there is a chmod user command and a chmod() system call. How would you find the appropriate manpage? You can tell man which section you'd like to look under. If you wanted to find the user command you would type: In some cases, the same topic will appear on more than one section of the manual. For example, there is a chmod user command and a chmod() system call. How would you find the appropriate manpage? You can tell man which section you'd like to look under. If you wanted to find the user command you would type:
  
-"% man 1 chmod"+  * man 1 chmod
  
 This would display the manpage for the user command chmod. References to the specific sections are traditionally placed in parenthesis after the command name like so: chmod(1) This would display the manpage for the user command chmod. References to the specific sections are traditionally placed in parenthesis after the command name like so: chmod(1)
Line 86: Line 88:
 Well, this is all fine and good if you know the name of the command, but what if you can't remember the name? 'man -k' can be used to search for keywords in the command descriptions. So, if you want to find a mail program you would type: Well, this is all fine and good if you know the name of the command, but what if you can't remember the name? 'man -k' can be used to search for keywords in the command descriptions. So, if you want to find a mail program you would type:
  
-"% man -k editor"+  * man -k editor
  
 A list of commands with the keyword "editor" in their descriptions will be presented on the screen. A list of commands with the keyword "editor" in their descriptions will be presented on the screen.
Line 96: Line 98:
 However, navigation is different in the standard info reader, as it is based on the "emacs" text editor. \\ Quick key help (for more, consult "info info"): However, navigation is different in the standard info reader, as it is based on the "emacs" text editor. \\ Quick key help (for more, consult "info info"):
  
-SPACE, BACKSPACEpage forward, backwardTABplace cursor onto next menu item or link (info files are hyperlinked)RETURNjump to the place where the link the cursor is sitting on points tol (the letter ell)get back to the spot from where last jump startedu n pup, next, previous node (info files are hierarchically structured)qquit the info reader+^Key ^ 
 +|SPACE, BACKSPACE | page forward, backward | 
 +|TAB|place cursor onto next menu item or link (info files are hyperlinked)| 
 +|RETURN|jump to the place where the link the cursor is sitting on points to| 
 +|l (the letter ell)|get back to the spot from where last jump started| 
 +|u n p|up, next, previous node (info files are hierarchically structured)| 
 +|q|quit the info reader|
  
 With most terminals, you can also move around using the cursor keys (arrows). With most terminals, you can also move around using the cursor keys (arrows).
Line 104: Line 112:
 There are also a number of tools at SDF that you can use to get more help. Type the following commands at a shell prompt. There are also a number of tools at SDF that you can use to get more help. Type the following commands at a shell prompt.
  
-helpThe SDF help system.faqA collection of frequently asked questions. Type 'g ' to enter a topic, 'l' to list the questions in the topic, and 't ' to read the FAQ. The FAQ is also available [[faq|on the SDF website]].helpdeskIf you cannot find your answer in the man pages, help, faq, or googling post a question to the helpdesk and a friendly member of the community will answer your question. Any member with ARPA status can login as an attendent to answer questions. Please note: in helpdesk you should only post questions directly related to SDF's systems, but not about general UNIX, programming or gardening - these belong to the bboard!bboardcomCom and bboard are meeting places for the SDF community. You could also pose your question there. Bboard and faq have the same interface. See [[tutorials/comnotirc|COM is not IRC]] for how to use com.+=== help ===  
 +The SDF help system. 
 +=== faq ===  
 +A collection of frequently asked questions. Type 'g ' to enter a topic, 'l' to list the questions in the topic, and 't ' to read the FAQ. The FAQ is also available [[faq:faq|on the SDF website]].
  
-And of course there are the online tutorials that you are reading right now! The top level page is http://sdf.lonestar.org/index.cgi?tutorials.+=== helpdesk ===  
 +If you cannot find your answer in the man pages, help, faq, or googling post a question to the helpdesk and a friendly member of the community will answer your question. Any member with ARPA status can login as an attendent to answer questions. Please note: in helpdesk you should only post questions directly related to SDF's systems, but not about general UNIX, programming or gardening - these belong to the bboard! 
 + 
 +=== bboard & com ===  
 +Com and bboard are meeting places for the SDF community. You could also pose your question there. Bboard and faq have the same interface. See [[tutorials:comnotirc|COM is not IRC]] for how to use com. 
 + 
 +And of course there are the online tutorials that you are reading right now! The top level page is [[tutorials:tutorials]]. 
 + 
 +$Id: findinghelp.html,v 1.10 2007/04/20 07:36:18 yargo Exp $