# 版權宣告: 1999 Copyright OLS3 All rights reserved.
# 作者: OLS3 (臥龍小三)
# 本講義僅供台南縣 87 學年度網路管理進階研習班上課之用.
# 學員可保存一份自用, 供日後網管時參考備查.
# 作者保有一切形式的著作權.
# 欲作其它用途者, 需經作者授權同意.
# 未經作者授權同意之前, 請勿轉載刊登.
線上文件 man pages
UNIX/Linux 這一類的作業系統通常含有非常豐富的線上文件, 我們稱之為 man pages.
man pages 可以幫助我們了解某些命令、程式、函式呼叫等等的使用方法.
比如說, 你想知道 groff 命令的用途以及參數選項, 可以在命令列中鍵入 man groff
其輸出結果如下:
GROFF(1) GROFF(1)
NAME
groff - front end for the groff document formatting system
SYNOPSIS
groff [ -tpeszaivhblCENRSVXZ ] [ -wname ] [ -Wname ] [
-mname ] [ -Fdir ] [ -Tdev ] [ -ffam ] [ -Mdir ] [ -dcs ]
[ -rcn ] [ -nnum ] [ -olist ] [ -Parg ] [ files... ]
DESCRIPTION
groff is a front-end to the groff document formatting sys�
tem. Normally it runs the troff program and a postproces�
sor appropriate for the selected device. Available
devices are:
ps For PostScript printers and previewers
dvi For TeX dvi format
X75 For a 75 dpi X11 previewer
X100 For a 100dpi X11 previewer
ascii For typewriter-like devices
latin1 For typewriter-like devices using the ISO Latin-1
character set.
lj4 For an HP LaserJet4-compatible (or other PCL5-com�
patible) printer.
The postprocessor to be used for a device is specified by
the postpro command in the device description file. This
can be overridden with the -X option.
The default device is ps. It can optionally preprocess
with any of pic, eqn, tbl, refer, or soelim.
Options without an argument can be grouped behind a single
-. A filename of - denotes the standard input.
The grog command can be used to guess the correct groff
command to use to format a file.
OPTIONS
-h Print a help message.
-e Preprocess with eqn.
-t Preprocess with tbl.
-p Preprocess with pic.
-s Preprocess with soelim.
Groff Version 1.11 15 August 1997 1
GROFF(1) GROFF(1)
-R Preprocess with refer. No mechanism is provided
for passing arguments to refer because most refer
options have equivalent commands which can be
included in the file. See refer(1) for more
details.
-v Make programs run by groff print out their version
number.
-V Print the pipeline on stdout instead of executing
it.
-z Suppress output from troff. Only error messages
will be printed.
-Z Do not postprocess the output of troff. Normally
groff will automatically run the appropriate post processor.
-Parg Pass arg to the postprocessor. Each argument
should be passed with a separate -P option. Note
that groff does not prepend - to arg before passing
it to the postprocessor.
-l Send the output to a printer. The command used for
this is specified by the print command in the
device description file.
-Larg Pass arg to the spooler. Each argument should be
passed with a separate -L option. Note that groff
does not prepend - to arg before passing it to the
postprocessor.
-Tdev Prepare output for device dev. The default device
is ps.
-X Preview with gxditview instead of using the usual
postprocessor. Groff passes gxditview a -printCom�
mand option which will make the Print action do
what groff would have done if the -l option had
been given. This is unlikely to produce good
results except with -Tps.
-N Don't allow newlines with eqn delimiters. This is
the same as the -N option in eqn.
-S Safer mode. Pass the -S option to pic and use the
-msafer macros with troff.
-a
-b
-i
-C
-E
Groff Version 1.11 15 August 1997 2
GROFF(1) GROFF(1)
-wname
-Wname
-mname
-olist
-dcs
-rcn
-Fdir
-Mdir
-ffam
-nnum These are as described in troff(1).
ENVIRONMENT
GROFF_COMMAND_PREFIX
If this is set X, then groff will run Xtroff
instead of troff. This also applies to tbl, pic,
eqn, refer and soelim. It does not apply to grops,
gro<jjc@jclark.com>dvi, grotty and gxditview.
GROFF_TMAC_PATH
A colon separated list of directories in which to
search for macro files.
GROFF_TYPESETTER
Default device.
GROFF_FONT_PATH
A colon separated list of directories in which to
search for the devname directory.
PATH The search path for commands executed by groff.
GROFF_TMPDIR
The directory in which temporary files will be cre�
ated. If this is not set and TMPDIR is set, tempo�
rary files will be created in that directory. Oth�
erwise temporary files will be created in /tmp.
The grops(1) and refer(1) commands can create tem�
porary files.
FILES
/usr/lib/groff/font/devname/DESC
Device description file for device name.
/usr/lib/groff/font/devname/F
Font file for font F of device name.
AUTHOR
James Clark
BUGS
Report bugs to bug-groff@prep.ai.mit.edu. Include a com�
plete, self-contained example that will allow the bug to
be reproduced, and say which version of groff you are
using.
Groff Version 1.11 15 August 1997 3
GROFF(1) GROFF(1)
COPYRIGHT
Copyright � 1989, 1990, 1991, 1992 Free Software Founda�
tion, Inc.
groff is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public
License as published by the Free Software Foundation;
either version 2, or (at your option) any later version.
groff is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied war�
ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR-�
POSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public
License along with groff; see the file COPYING. If not,
write to the Free Software Foundation, 59 Temple Place -
Suite 330, Boston, MA 02111-1307, USA.
AVAILABILITY
The most recent released version of groff is always avail�
able for anonymous ftp from prep.ai.mit.edu (18.71.0.38)
in the directory pub/gnu.
SEE ALSO
grog(1), troff(1), tbl(1), pic(1), eqn(1), soelim(1),
refer(1), grops(1), grodvi(1), grotty(1), gxditview(1),
groff_font(5), groff_out(5), groff_ms(7), me(7),
groff_char(7), msafer(7)
Groff Version 1.11 15 August 1997 4
man pages 的操作:
man 會將輸出結果自動 pipe 給 less, 因此進入閱讀畫面之後, 可以使用 less 的操作方式
比如: ^f 是往下一頁, ^b 是往上一頁, h 叫出 Help, q 則是離開.
如何閱讀 man pages 說明:
它代表 man pages 的章節(section). 每一 section 都代表不同的作用內容.
GROFF(1) 表示 groff 這支程式是屬於 section 1, 是一種使用者層級的命令.
section 作用內容 1 user commands
使用者命令8 system commands
系統命令2 system calls
系統呼叫3 library calls
函式庫呼叫4 devices
設備5 file formats
檔案格式6 games
電腦遊戲7 miscellaneous
其它雜項9 kernel internals
核心內部n Tcl/Tk commands
Tcl/Tk script 命令上述排列順序恰也是 man pages 的搜尋順序.
同一命令可能出現在不同章節中, 如果您想要查閱某一章節中某一命令, 則必須加以指定 section 代碼, 如: man 2 swapon 或 man 8 swapon.
man pages 在那裡?
man -w 可以顯示 man pages 的搜尋路徑, 比如:
man page 如何製作?
man pages 主要使用 groff 語法, 詳情可參考:
以下是一個簡單的例子:
.\" Process this file with .\" groff -man -Tascii foo.1 .\" .TH FOO 1 "臥龍小三 1999" Linux "使用者手冊" .SH NAME foo \- 線上手冊示範 .SH SYNOPSIS .B foo [-選項1] [-選項2 .I 設定檔 .B ] .I 待處理的檔案 .B ... .SH DESCRIPTION .B foo 這支程式的名稱是 foo, 並且假設作者將它定位在 section 1, 也就是使用者命令, 所以要將這篇線上文件命名為 foo.1, 我們可在自家目錄中來測試一下: -------------------------------------------------------------------假設這支程式的名稱是 foo, 並且欲將它定位在 section 1, 也就是使用者命令, 所以要將這篇線上文件命名為 foo.1, 我們可在自家目錄中來測試一下:
man ./foo.1
若一切正常, 再將它放入 /usr/man/man1 的目錄中, 欲查看 foo 的用法, 只要下 man foo 即可.
以下是 man ./foo.1 的輸出畫面.
FOO(1) 使用者手冊 FOO(1) NAME foo - 線上手冊示範 SYNOPSIS foo [-選項1] [-選項2 設定檔 ] 待處理的檔案 ... DESCRIPTION foo 這支程式的名稱是 foo, 並且假設作者將它定位在 section 1, 也就是使用者命令, 所以要將這篇線上文件命名為 foo.1, 我們可在自家目錄中來測試一下: Linux 臥龍小三 1999 1 (END)
關鍵字查 man pages
上述 man pages , 雖然提供了一個不錯的線上文件查詢環境, 但並不是很十分方便!
有時我們並不是想要查程式或者指令, 只是想查詢和某一關鍵字相關的文件內容.
以下指令可以用關鍵字來查 man pages.
這三個指令其實是一樣的. 不過, 在使用這個指令之前, 應該先建立 whatis 的資料庫, 否則將看不到任何查詢結果. 這個資料庫的建立, RedHat 是用 crontab 安排在半夜執行, 因為現在尚未到半夜, 所以只好手動來建立. 請執行:
/etc/cron.weekly/makewhatis.cron
之後, 我們便可以用它們以關鍵字來查詢文件囉! 比如, 要查 make 這個字串:
皆得到相同的結果.