Download - Ch02 Documentation
-
8/9/2019 Ch02 Documentation
1/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
Chapter 2:Documentation
-
8/9/2019 Ch02 Documentation
2/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
Objectives
M an pages and man commandM anual EntriesRelated Commands
Info CommandDocumentation in /usr/docOnline Documentation
Hardcopy DocumentationSelf-Directed Review Excercises
-
8/9/2019 Ch02 Documentation
3/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
Man pag es and man co mand
G et Information about most commandsInformation about each command include:
Command nameSynopsis and descriptionList and definition of all optionsEnvironment and parameters
Sections in man command include:
-
8/9/2019 Ch02 Documentation
4/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
Man pag es and man co mand
Comman Sections1 - user command2 - system calls
3 c library functions4 discription of configuration file5 file formats (syntax)
Syntax man commandM an /etc/man.config
-
8/9/2019 Ch02 Documentation
5/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
Manual En tries
M anual pages mostly stored /usr/man, /usr/local/manor /usr/share/man
Troff/nroff format manual pages (compressed).
Formatted manual pages are usuallytemporarily stored under /var/share/man.M anual pages are displayed by more (default),can override by set PA G ER.
-
8/9/2019 Ch02 Documentation
6/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
R e la te d C o mmand s
Most linux systems (maintain the index or old-fashionedso-called whatis database)Use whatis command to print the short description of acommand.
$whatis man or $man f manman (1) - format and display the on-line
manual pagesman (7) - macros to format man pages
Use apropos command to print the short description of command contain a pattern.$apropos bootthe output will print description of commands
contain boot word.
-
8/9/2019 Ch02 Documentation
7/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
I nf o C o mmand
Info is a GNU help utility,contain fullinformaiton. U se hypertext links.
$info man
-
8/9/2019 Ch02 Documentation
8/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
D oc um e n t a tio n in /u sr /d oc, /u sr /sh a re /d oc
Contain documentation doesnt fall under manpage or info, include HOWTOs, user guide, FAQs,READMEs,Generally classify into thesecategories
HOWTOs: Detailed guides on how to perform aparticular function or task.A number of HOWTOslocation at Linux Documentation Projects websiteProgram-specific: This Documentation included
with a particular package. Documentation includeREADMEs, CHANGES,..Frequently Asked Questions: Also known as FAQs,contain a list of questions about a topic.Usually in aquestion and answer format.
-
8/9/2019 Ch02 Documentation
9/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
O nl in e D oc um e n t a tio n
V ast amounts of information available online.G reat online resources such as the LinuxDocumentation Project and newgroups
V endor specific products such as hardware or programs at vendor website,eg: apache.org,kde.org
-
8/9/2019 Ch02 Documentation
10/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
H a r d co py D oc um e n t a tio n
Three types of hard-copy manuals:Reference booksG uide booksTutorials
Some hard-copy documentationRed Hat Linux Administrators handbook, 2 ndEditionRed Hat Linux 7 Server Red Hat Linux Survival G uidedownload from http://www.evoknow.com
-
8/9/2019 Ch02 Documentation
11/11
SAIGONLAB83 Nguy n Th Nh , P9, Q.Tn B nh, Tp. HCM LPI 102
S umma r y
U se the man commandU se the info commandIdentify and locate system documentation
Identify and use online documentation such as TheLinux Documentation Project