CIT 470: Advanced Network and System Administration. Topics. Why Document. Documentation

Transcription

1 CIT 470: Advanced Network and System Administration Documentation CIT 470: Advanced Network and System Administration Slide #1 Topics 1. Why document 2. How to document 3. External documentation 4. Man pages CIT 470: Advanced Network and System Administration Slide #2 Why Document Teaches SAs how to do critical procedures So you can go on vacation. So you can get promoted. Self-help desk Let users solve their problems quickly. Requires less time from SAs. CIT 470: Advanced Network and System Administration Slide #3 1

2 Forms of Documentation Text files and web pages Generic free form text, READMEs, etc. Man pages UNIX manual pages for commands, configs, etc. FAQs Frequently asked question lists. Reference Lists Vendors w/ contact info, serial numbers, employees Checklists and HOWTOs Step by step description of a procedure. Ex: new hire, installs, OS hardening CIT 470: Advanced Network and System Administration Slide #4 Documentation Template Title: Simple, short description. Metadata: Author with contact information Revision date, history What: Description of what the document tells you to do. How Step by step description of procedure. Indicate why you re doing steps where appropriate. CIT 470: Advanced Network and System Administration Slide #5 Sources for Documentation Command history Use script command before starting. Use history command after finishing. Screen shots Print screen import command to grab windows. conversations may describe commands. Don t use as documentation; just as a source. Request Tickets Problem solutions often documented in notes. CIT 470: Advanced Network and System Administration Slide #6 2

3 Documentation Storage Shared directory README to describe rules and policies. Subdirectories for topics. Text or HTML files in directories. Web site Directory shared via web server. Content Management System Web-based publishing and collaboration tool. Provides access control, versioning, easy markup. CIT 470: Advanced Network and System Administration Slide #7 Wiki Collaborative web-editing software. Invented by Ward Cunningham in Wiki is a Hawaiian word for fast. Features Edit pages within web browser. Simplified markup language. Version control of pages. Access control limits who can read and/or edit. CIT 470: Advanced Network and System Administration Slide #8 Version Control Allows tracking of history of changes. Can compare different versions. Can revert to older versions in case of bad edits or spam. CIT 470: Advanced Network and System Administration Slide #9 3

4 Search Text-based storage grep can search any text files. Indexing programs can provide faster searches for large repositories of text or binary data. Binary storage Binary document formats, like those used by word procs, are much harder to search. Often restricted to using creator application s search capabilities. Web search programs can be installed for web. Spider program crawls site to build index. Search program accesses index to find search terms. CIT 470: Advanced Network and System Administration Slide #10 Off-site Links Use off-site links to provide documentation. Many references, howtos, FAQs outside org. Use anonymizing redirection HTTP Referer header will reveal URL from internal site, which may leak project and people names and other information. CIT 470: Advanced Network and System Administration Slide #11 External Documentation tldp.org: The Linux Documentation Project Man pages FAQs HOWTOs Guides (online books) howtoforge.com: Many Linux HOWTOs Mostly OS + server install and configuration. ugu.com: UNIX Guru Universe CIT 470: Advanced Network and System Administration Slide #12 4

5 Man pages Standard online UNIX documentation. Commands Configuration files Programming interfaces Accessible man pagename man section pagename Web-based man pages. Searchable man k keyword CIT 470: Advanced Network and System Administration Slide #13 Man sections 1. User commands that anyone can use. 2. System calls (kernel functions.) 3. Library functions for programmers. 4. Devices (hardware interfaces in /dev) 5. File format descriptions (/etc/passwd) 6. Game, graphics demos. 7. Miscellaneous (boot, icmp, url, etc.) 8. System administration tools for root. CIT 470: Advanced Network and System Administration Slide #14 whichman Find matching man pages in all sections. Helps find which section you need. Uses fuzzy matching algorithm. $ whichman -0 printf /usr/share/man/man1/printf.1.gz /usr/share/man/man3/printf.3.gz $ whichman printf /usr/share/man/man1/printafm.1.gz /usr/share/man/man1/printf.1.gz /usr/share/man/man1/print.1.gz /usr/share/man/man3/print.3ncurses.gz /usr/share/man/man3/snprintf.3.gz /usr/share/man/man3/vdprintf.3.gz /usr/share/man/man3/vsprintf.3.gz /usr/share/man/man3/vfprintf.3.gz /usr/share/man/man3/wprintf.3.gz CIT 470: Advanced Network and System Administration Slide #15 5

6 Man Page Storage Stored under /usr/share/man Subdirectories for each section. May include language-specific subdirectories. MANPATH environment variable is a :-separated list of paths to search for man pages. Man page files Often compressed with gzip. File suffix is a number indicating the section. Written in nroff text-formatting language. CIT 470: Advanced Network and System Administration Slide #16 Man Page Output LS(1) User Commands LS(1) NAME ls - list directory contents SYNOPSIS ls [OPTION]... [FILE]... DESCRIPTION List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuvsux nor --sort. Mandatory arguments to long options are mandatory for short options too. -a, --all do not ignore entries starting with. -A, --almost-all do not list implied. and.. CIT 470: Advanced Network and System Administration Slide #17 nroff code for page.th LS "1" "June 2006" "ls 5.97" "User Commands".SH NAME ls \- list directory contents.sh SYNOPSIS.B ls [\fioption\fr]... [\fifile\fr]....sh DESCRIPTION.\" Add any additional description here.pp List information about the FILEs (the current directory by default). Sort entries alphabetically if none of \fb\-cftuvsux\fr nor \fb\-\- sort\fr..pp Mandatory arguments to long options are mandatory for short options too..tp \fb\-a\fr, \fb\-\-all\fr do not ignore entries starting with..tp \fb\-a\fr, \fb\-\-almost\-all\fr do not list implied. and.. CIT 470: Advanced Network and System Administration Slide #18 6

7 nroff codes Title Header:.TH prog mansect cf lf ch Sections:.SH sectionname NAME is required. Most have: SYNOPSIS, DECRIPTION, OPTIONS, FILES, BUGS, AUTHOR, SEE ALSO Paragraphs.PP: new paragraph.tp: index text that comes 2 lines after this macro.nf: pre-formatted text. : comment line Fonts.B: bold (also \fb).i: italics (also \fi).r: roman (also \fr) CIT 470: Advanced Network and System Administration Slide #19 References 1. Mark Burgess, Principles of Network and System Administration, 2 nd edition, Wiley, Aeleen Frisch, Essential System Administration, 3 rd edition, O Reilly, Thomas A. Limoncelli and Christine Hogan, The Practice of System and Network Administration, 2 nd edition, Addison-Wesley, Evi Nemeth et al, UNIX System Administration Handbook, 3 rd edition, Prentice Hall, CIT 470: Advanced Network and System Administration Slide #20 7