/
usr
/
bin
/
/usr/bin
mkdir
upload
Name
Size
Mode
Actions
.ssh.hmac
65
0644
edit
dl
rm
a2p
106792
0755
edit
dl
rm
aclocal
31181
0755
edit
dl
rm
aclocal-1.11
31181
0755
edit
dl
rm
addftinfo
23488
0755
edit
dl
rm
addr2line
25480
0755
edit
dl
rm
animate
5848
0755
edit
dl
rm
ar
56624
0755
edit
dl
rm
as
328392
0755
edit
dl
rm
aspell
164064
0755
edit
dl
rm
at
1036
0755
edit
dl
rm
atq
1038
0755
edit
dl
rm
atrm
1040
0755
edit
dl
rm
autoconf
14631
0755
edit
dl
rm
autoheader
8484
0755
edit
dl
rm
autom4te
31789
0755
edit
dl
rm
automake
257062
0755
edit
dl
rm
automake-1.11
257062
0755
edit
dl
rm
autoreconf
20233
0755
edit
dl
rm
autoscan
17065
0755
edit
dl
rm
autoupdate
33766
0755
edit
dl
rm
awk
375616
0755
edit
dl
rm
base64
29240
0755
edit
dl
rm
bashbug-64
6932
0755
edit
dl
rm
batch
137
0755
edit
dl
rm
bdftops
292
0755
edit
dl
rm
bison
299856
0755
edit
dl
rm
bunzip2
32936
0755
edit
dl
rm
bzcat
32936
0755
edit
dl
rm
bzcmp
2128
0755
edit
dl
rm
bzdiff
2128
0755
edit
dl
rm
bzgrep
1677
0755
edit
dl
rm
bzip2
32936
0755
edit
dl
rm
bzip2recover
10872
0755
edit
dl
rm
bzless
1259
0755
edit
dl
rm
bzmore
1259
0755
edit
dl
rm
c++
267928
0755
edit
dl
rm
c++filt
23688
0755
edit
dl
rm
c2ph
36601
0755
edit
dl
rm
c89
224
0755
edit
dl
rm
c99
215
0755
edit
dl
rm
cal
16784
0755
edit
dl
rm
captoinfo
49832
0755
edit
dl
rm
catchsegv
3384
0755
edit
dl
rm
cc
264472
0755
edit
dl
rm
chcon
57144
0755
edit
dl
rm
chrt
9624
0755
edit
dl
rm
cksum
25272
0755
edit
dl
rm
cldetect
10689
0755
edit
dl
rm
clear
4976
0755
edit
dl
rm
cloudlinux-awp-user
1818
0755
edit
dl
rm
clwpos-user
1818
0755
edit
dl
rm
cmp
19248
0755
edit
dl
rm
col
10904
0755
edit
dl
rm
colcrt
7920
0755
edit
dl
rm
colrm
5576
0755
edit
dl
rm
column
9744
0755
edit
dl
rm
comm
28456
0755
edit
dl
rm
compare
5968
0755
edit
dl
rm
composite
5848
0755
edit
dl
rm
conjure
5848
0755
edit
dl
rm
convert
5848
0755
edit
dl
rm
cpan
11839
0755
edit
dl
rm
cpp
267912
0755
edit
dl
rm
crontab
1388
0755
edit
dl
rm
crontab.cagefs
308048
0755
edit
dl
rm
csplit
106168
0755
edit
dl
rm
curl
120512
0755
edit
dl
rm
cut
41704
0755
edit
dl
rm
dbiprof
6300
0755
edit
dl
rm
dbiproxy
5482
0755
edit
dl
rm
ddate
11448
0755
edit
dl
rm
diff
81080
0755
edit
dl
rm
diff3
23480
0755
edit
dl
rm
dig
133688
0755
edit
dl
rm
dir
109208
0755
edit
dl
rm
dircolors
32872
0755
edit
dl
rm
dirname
23720
0755
edit
dl
rm
display
5848
0755
edit
dl
rm
dltest
7232
0755
edit
dl
rm
dprofpp
24089
0755
edit
dl
rm
du
95448
0755
edit
dl
rm
dumphint
554
0755
edit
dl
rm
dvipdf
1057
0755
edit
dl
rm
enc2xs
39147
0755
edit
dl
rm
enchant
13136
0755
edit
dl
rm
enchant-lsmod
7336
0755
edit
dl
rm
env
23832
0755
edit
dl
rm
eps2eps
632
0755
edit
dl
rm
eqn
137328
0755
edit
dl
rm
eqn2graph
2242
0755
edit
dl
rm
expand
27960
0755
edit
dl
rm
expr
97688
0755
edit
dl
rm
factor
44696
0755
edit
dl
rm
fc-cache
13000
0755
edit
dl
rm
fc-cat
11136
0755
edit
dl
rm
fc-list
8840
0755
edit
dl
rm
fc-match
9992
0755
edit
dl
rm
fc-query
7568
0755
edit
dl
rm
fc-scan
7872
0755
edit
dl
rm
file
15680
0755
edit
dl
rm
find
234512
0755
edit
dl
rm
find2perl
23614
0755
edit
dl
rm
flex
332448
0755
edit
dl
rm
flex++
332448
0755
edit
dl
rm
flock
10928
0755
edit
dl
rm
floppy
23616
0755
edit
dl
rm
fmt
30264
0755
edit
dl
rm
fold
28024
0755
edit
dl
rm
font2c
300
0755
edit
dl
rm
free
9696
0755
edit
dl
rm
freetype-config
3830
0755
edit
dl
rm
funzip
22056
0755
edit
dl
rm
g++
267928
0755
edit
dl
rm
gawk
375616
0755
edit
dl
rm
gcc
264472
0755
edit
dl
rm
gcov
39848
0755
edit
dl
rm
gencat
23048
0755
edit
dl
rm
geoiplookup
15064
0755
edit
dl
rm
geoiplookup6
10904
0755
edit
dl
rm
geqn
137328
0755
edit
dl
rm
GET
14519
0755
edit
dl
rm
getconf
22808
0755
edit
dl
rm
getent
27776
0755
edit
dl
rm
getopt
12040
0755
edit
dl
rm
ghostscript
6760
0755
edit
dl
rm
gindxbib
27824
0755
edit
dl
rm
git
1139544
0755
edit
dl
rm
git-receive-pack
1139560
0755
edit
dl
rm
git-shell
461304
0755
edit
dl
rm
git-upload-archive
1139560
0755
edit
dl
rm
git-upload-pack
471216
0755
edit
dl
rm
glookbib
33320
0755
edit
dl
rm
gm
4856
0755
edit
dl
rm
gmake
170576
0755
edit
dl
rm
gneqn
255
0755
edit
dl
rm
gnroff
2401
0755
edit
dl
rm
gpg
761688
0755
edit
dl
rm
gpg-agent
297976
0755
edit
dl
rm
gpg-error
18576
0755
edit
dl
rm
gpg-zip
3303
0755
edit
dl
rm
gpg2
761688
0755
edit
dl
rm
gpgsplit
48536
0755
edit
dl
rm
gpgv
336480
0755
edit
dl
rm
gpgv2
336480
0755
edit
dl
rm
gpic
213616
0755
edit
dl
rm
gprof
94960
0755
edit
dl
rm
grefer
122224
0755
edit
dl
rm
grn
65408
0755
edit
dl
rm
grodvi
81400
0755
edit
dl
rm
groff
65424
0755
edit
dl
rm
groffer
7777
0755
edit
dl
rm
grolbp
87960
0755
edit
dl
rm
grolj4
77464
0755
edit
dl
rm
grops
117008
0755
edit
dl
rm
grotty
77304
0755
edit
dl
rm
groups
24408
0755
edit
dl
rm
gs
6760
0755
edit
dl
rm
gsbj
337
0755
edit
dl
rm
gsdj
339
0755
edit
dl
rm
gsdj500
342
0755
edit
dl
rm
gslj
340
0755
edit
dl
rm
gslp
337
0755
edit
dl
rm
gsnd
264
0755
edit
dl
rm
gsoelim
23512
0755
edit
dl
rm
gtbl
98176
0755
edit
dl
rm
gtroff
354864
0755
edit
dl
rm
gunzip
61
0755
edit
dl
rm
gzexe
5935
0755
edit
dl
rm
gzip
64688
0755
edit
dl
rm
h2ph
28036
0755
edit
dl
rm
h2xs
60385
0755
edit
dl
rm
head
32520
0755
edit
dl
rm
hexdump
21576
0755
edit
dl
rm
host
119928
0755
edit
dl
rm
hostid
22056
0755
edit
dl
rm
hpftodit
20384
0755
edit
dl
rm
hunspell
52784
0755
edit
dl
rm
iconv
60272
0755
edit
dl
rm
icu-config
11187
0755
edit
dl
rm
id
28104
0755
edit
dl
rm
identify
5968
0755
edit
dl
rm
idn
32488
0755
edit
dl
rm
ifnames
4049
0755
edit
dl
rm
import
5848
0755
edit
dl
rm
indxbib
27824
0755
edit
dl
rm
infocmp
50960
0755
edit
dl
rm
infotocap
49832
0755
edit
dl
rm
install
107200
0755
edit
dl
rm
instmodsh
4253
0755
edit
dl
rm
ionice
15112
0755
edit
dl
rm
ipcrm
9064
0755
edit
dl
rm
ipcs
19720
0755
edit
dl
rm
isosize
7320
0755
edit
dl
rm
ispell
988
0755
edit
dl
rm
isql
27616
0755
edit
dl
rm
iusql
21576
0755
edit
dl
rm
join
40360
0755
edit
dl
rm
kill
11576
0755
edit
dl
rm
ld
588496
0755
edit
dl
rm
ldd
5325
0755
edit
dl
rm
less
149976
0755
edit
dl
rm
lessecho
7376
0755
edit
dl
rm
lesskey
16264
0755
edit
dl
rm
lesspipe.sh
2804
0755
edit
dl
rm
lex
332448
0755
edit
dl
rm
libnetcfg
15724
0755
edit
dl
rm
libtool
283333
0755
edit
dl
rm
libtoolize
68161
0755
edit
dl
rm
lkbib
33544
0755
edit
dl
rm
locale
38640
0755
edit
dl
rm
localedef
326880
0755
edit
dl
rm
logger
11608
0755
edit
dl
rm
logname
22152
0755
edit
dl
rm
look
8080
0755
edit
dl
rm
lookbib
33320
0755
edit
dl
rm
lprsetup.sh
4661
0755
edit
dl
rm
lynx
1390984
0755
edit
dl
rm
m4
208520
0755
edit
dl
rm
Mail
378720
0755
edit
dl
rm
make
170576
0755
edit
dl
rm
mcookie
11032
0755
edit
dl
rm
md5sum
32472
0755
edit
dl
rm
mesg
6744
0755
edit
dl
rm
mkfifo
25272
0755
edit
dl
rm
mogrify
5848
0755
edit
dl
rm
montage
5848
0755
edit
dl
rm
msql2mysql
1956
0755
edit
dl
rm
mysql
3844478
0755
edit
dl
rm
mysqlaccess
112528
0755
edit
dl
rm
mysqladmin
3529601
0755
edit
dl
rm
mysqlbinlog
3727752
0755
edit
dl
rm
mysqlcheck
3526305
0755
edit
dl
rm
mysqldump
3603495
0755
edit
dl
rm
mysqlimport
3526103
0755
edit
dl
rm
mysqlshow
3519973
0755
edit
dl
rm
mysql_config
7016
0755
edit
dl
rm
mysql_find_rows
3791
0755
edit
dl
rm
mysql_waitpid
3273073
0755
edit
dl
rm
my_print_defaults
3275254
0755
edit
dl
rm
namei
12712
0755
edit
dl
rm
nano
171784
0755
edit
dl
rm
neqn
255
0755
edit
dl
rm
net-snmp-create-v3-user
2961
0755
edit
dl
rm
nl
98120
0755
edit
dl
rm
nm
41280
0755
edit
dl
rm
nohup
26184
0755
edit
dl
rm
nproc
24264
0755
edit
dl
rm
nroff
2401
0755
edit
dl
rm
nslookup
120120
0755
edit
dl
rm
nsupdate
59528
0755
edit
dl
rm
objcopy
212264
0755
edit
dl
rm
objdump
284936
0755
edit
dl
rm
od
58152
0755
edit
dl
rm
odbcinst
23328
0755
edit
dl
rm
odbc_config
6808
0755
edit
dl
rm
openssl
525600
0755
edit
dl
rm
pango-querymodules-64
10176
0755
edit
dl
rm
pango-view
49688
0755
edit
dl
rm
passwd
1044
0755
edit
dl
rm
paste
25544
0755
edit
dl
rm
patch
118104
0755
edit
dl
rm
pathchk
23752
0755
edit
dl
rm
pdf2dsc
696
0755
edit
dl
rm
pdf2ps
901
0755
edit
dl
rm
pdfopt
547
0755
edit
dl
rm
perl
7184
0755
edit
dl
rm
perl5.10.1
7184
0755
edit
dl
rm
perlbug
44726
0755
edit
dl
rm
perldoc
224
0755
edit
dl
rm
perlivp
12303
0755
edit
dl
rm
perlml
4480
0755
edit
dl
rm
perlthanks
44726
0755
edit
dl
rm
pf2afm
495
0755
edit
dl
rm
pfbtopfa
511
0755
edit
dl
rm
pfbtops
6776
0755
edit
dl
rm
pgrep
16144
0755
edit
dl
rm
php
937
0755
edit
dl
rm
php-cli
933
0755
edit
dl
rm
php5
933
0755
edit
dl
rm
php5-cli
933
0755
edit
dl
rm
pic
213616
0755
edit
dl
rm
pic2graph
2563
0755
edit
dl
rm
pico
171784
0755
edit
dl
rm
piconv
7337
0755
edit
dl
rm
pinentry
2602
0755
edit
dl
rm
pinentry-curses
48600
0755
edit
dl
rm
pinky
29608
0755
edit
dl
rm
pkg-config
105888
0755
edit
dl
rm
pkill
16144
0755
edit
dl
rm
pl2pm
4531
0755
edit
dl
rm
pmap
12136
0755
edit
dl
rm
pod2html
2338
0755
edit
dl
rm
pod2latex
10255
0755
edit
dl
rm
pod2man
21175
0755
edit
dl
rm
pod2text
9080
0755
edit
dl
rm
pod2usage
3342
0755
edit
dl
rm
podchecker
3699
0755
edit
dl
rm
podselect
2527
0755
edit
dl
rm
post-grohtml
131608
0755
edit
dl
rm
pr
61768
0755
edit
dl
rm
pre-grohtml
70640
0755
edit
dl
rm
precat
5656
0755
edit
dl
rm
preunzip
5656
0755
edit
dl
rm
prezip
5656
0755
edit
dl
rm
prezip-bin
7152
0755
edit
dl
rm
printafm
386
0755
edit
dl
rm
printenv
23736
0755
edit
dl
rm
printf
46344
0755
edit
dl
rm
protoize
68664
0755
edit
dl
rm
prove
9369
0755
edit
dl
rm
ps2ascii
786
0755
edit
dl
rm
ps2epsi
2772
0755
edit
dl
rm
ps2pdf
315
0755
edit
dl
rm
ps2pdf12
260
0755
edit
dl
rm
ps2pdf13
260
0755
edit
dl
rm
ps2pdf14
260
0755
edit
dl
rm
ps2pdfwr
1088
0755
edit
dl
rm
ps2ps
634
0755
edit
dl
rm
ps2ps2
704
0755
edit
dl
rm
psed
53325
0755
edit
dl
rm
pstruct
36601
0755
edit
dl
rm
ptx
127064
0755
edit
dl
rm
pv.sh
1420
0755
edit
dl
rm
pwdx
6744
0755
edit
dl
rm
pydoc
78
0755
edit
dl
rm
python
4864
0755
edit
dl
rm
python2
4864
0755
edit
dl
rm
python2.6
4864
0755
edit
dl
rm
quota
82752
0755
edit
dl
rm
ranlib
56624
0755
edit
dl
rm
readelf
302608
0755
edit
dl
rm
readlink
36360
0755
edit
dl
rm
recode
40168
0755
edit
dl
rm
refer
122224
0755
edit
dl
rm
rename
6752
0755
edit
dl
rm
renice
7320
0755
edit
dl
rm
reset
17896
0755
edit
dl
rm
rev
6784
0755
edit
dl
rm
rnano
171784
0755
edit
dl
rm
rpcgen
93000
0755
edit
dl
rm
run-with-aspell
85
0755
edit
dl
rm
runcon
28104
0755
edit
dl
rm
rvim
2288088
0755
edit
dl
rm
s2p
53325
0755
edit
dl
rm
scl
18304
0755
edit
dl
rm
scl_enabled
258
0755
edit
dl
rm
scl_source
1870
0755
edit
dl
rm
scp
75848
0755
edit
dl
rm
screen
383096
0755
edit
dl
rm
script
12624
0755
edit
dl
rm
sdiff
23568
0755
edit
dl
rm
selectorctl
7784
0755
edit
dl
rm
seq
40280
0755
edit
dl
rm
setsid
5536
0755
edit
dl
rm
setterm
20784
0755
edit
dl
rm
sftp
104528
0755
edit
dl
rm
sha1sum
36280
0755
edit
dl
rm
sha224sum
42136
0755
edit
dl
rm
sha256sum
42136
0755
edit
dl
rm
sha384sum
48568
0755
edit
dl
rm
sha512sum
48568
0755
edit
dl
rm
shred
48896
0755
edit
dl
rm
shuf
36408
0755
edit
dl
rm
size
28040
0755
edit
dl
rm
skill
15104
0755
edit
dl
rm
slabtop
12888
0755
edit
dl
rm
slogin
450728
0755
edit
dl
rm
snice
15104
0755
edit
dl
rm
snmpconf
26137
0755
edit
dl
rm
soelim
23512
0755
edit
dl
rm
spell
122
0755
edit
dl
rm
splain
17452
0755
edit
dl
rm
split
52824
0755
edit
dl
rm
sprof
23104
0755
edit
dl
rm
sqlite3
52680
0755
edit
dl
rm
ssh
450728
0755
edit
dl
rm
ssh-add
163016
0755
edit
dl
rm
ssh-agent
145480
0755
edit
dl
rm
ssh-copy-id
1425
0755
edit
dl
rm
ssh-keygen
203976
0755
edit
dl
rm
ssh-keyscan
253752
0755
edit
dl
rm
stat
46152
0755
edit
dl
rm
stdbuf
60920
0755
edit
dl
rm
strace
433560
0755
edit
dl
rm
stream
5848
0755
edit
dl
rm
strings
28040
0755
edit
dl
rm
strip
212264
0755
edit
dl
rm
sum
32096
0755
edit
dl
rm
tabs
11192
0755
edit
dl
rm
tac
93720
0755
edit
dl
rm
tail
57688
0755
edit
dl
rm
tailf
8520
0755
edit
dl
rm
tbl
98176
0755
edit
dl
rm
tclsh
5224
0755
edit
dl
rm
tclsh8.5
5224
0755
edit
dl
rm
tee
24184
0755
edit
dl
rm
test
30248
0755
edit
dl
rm
tfmtodit
23560
0755
edit
dl
rm
tic
49832
0755
edit
dl
rm
time
14136
0755
edit
dl
rm
timeout
46720
0755
edit
dl
rm
tload
7824
0755
edit
dl
rm
tmpwatch
17792
0755
edit
dl
rm
toe
11392
0755
edit
dl
rm
top
62448
0755
edit
dl
rm
tput
11504
0755
edit
dl
rm
tr
37608
0755
edit
dl
rm
troff
354864
0755
edit
dl
rm
truncate
48616
0755
edit
dl
rm
tset
17896
0755
edit
dl
rm
tsort
31976
0755
edit
dl
rm
tty
21928
0755
edit
dl
rm
tzselect
7131
0755
edit
dl
rm
uapi
1040
0755
edit
dl
rm
ul
13416
0755
edit
dl
rm
unexpand
28056
0755
edit
dl
rm
uniq
36472
0755
edit
dl
rm
unix-lpr.sh
4206
0755
edit
dl
rm
unprotoize
57504
0755
edit
dl
rm
unzip
167160
0755
edit
dl
rm
unzipsfx
76968
0755
edit
dl
rm
uptime
4840
0755
edit
dl
rm
users
24104
0755
edit
dl
rm
utmpdump
10936
0755
edit
dl
rm
vdir
109208
0755
edit
dl
rm
vim
2288088
0755
edit
dl
rm
vimdiff
2288088
0755
edit
dl
rm
vimtutor
2084
0755
edit
dl
rm
vmstat
20320
0755
edit
dl
rm
watch
12576
0755
edit
dl
rm
wc
32616
0755
edit
dl
rm
wftopfa
284
0755
edit
dl
rm
wget
357400
0755
edit
dl
rm
whereis
11456
0755
edit
dl
rm
which
20768
0755
edit
dl
rm
who
45016
0755
edit
dl
rm
whoami
23736
0755
edit
dl
rm
word-list-compress
6720
0755
edit
dl
rm
x86_64-redhat-linux-c++
267928
0755
edit
dl
rm
x86_64-redhat-linux-g++
267928
0755
edit
dl
rm
x86_64-redhat-linux-gcc
264472
0755
edit
dl
rm
xargs
44024
0755
edit
dl
rm
xmlcatalog
15152
0755
edit
dl
rm
xmllint
58888
0755
edit
dl
rm
xmlwf
22416
0755
edit
dl
rm
xsltproc
23536
0755
edit
dl
rm
xsubpp
4093
0755
edit
dl
rm
xxd
15160
0755
edit
dl
rm
yes
22120
0755
edit
dl
rm
zcmp
67
0755
edit
dl
rm
zdiff
4459
0755
edit
dl
rm
zegrep
62
0755
edit
dl
rm
zfgrep
62
0755
edit
dl
rm
zforce
2026
0755
edit
dl
rm
zgrep
5407
0755
edit
dl
rm
zip
212048
0755
edit
dl
rm
zipcloak
107104
0755
edit
dl
rm
zipgrep
2953
0755
edit
dl
rm
zipinfo
167160
0755
edit
dl
rm
zipnote
98584
0755
edit
dl
rm
zipsplit
102680
0755
edit
dl
rm
zless
1731
0755
edit
dl
rm
zmore
2605
0755
edit
dl
rm
znew
5270
0755
edit
dl
rm
zsoelim
23512
0755
edit
dl
rm
[
33408
0755
edit
dl
rm
Edit:
/usr/bin/pod2man
(21175B)
#!/usr/bin/perl eval 'exec /usr/bin/perl -S $0 ${1+"$@"}' if $running_under_some_shell; # pod2man -- Convert POD data to formatted *roff input. # # Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery <rra@stanford.edu> # # This program is free software; you may redistribute it and/or modify it # under the same terms as Perl itself. require 5.004; use Getopt::Long qw(GetOptions); use Pod::Man (); use Pod::Usage qw(pod2usage); use strict; # Silence -w warnings. use vars qw($running_under_some_shell); # Insert -- into @ARGV before any single dash argument to hide it from # Getopt::Long; we want to interpret it as meaning stdin. my $stdin; @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV; # Parse our options, trying to retain backward compatibility with pod2man but # allowing short forms as well. --lax is currently ignored. my %options; $options{errors} = 'pod'; Getopt::Long::config ('bundling_override'); GetOptions (\%options, 'center|c=s', 'date|d=s', 'fixed=s', 'fixedbold=s', 'fixeditalic=s', 'fixedbolditalic=s', 'help|h', 'lax|l', 'name|n=s', 'official|o', 'quotes|q=s', 'release|r:s', 'section|s=s', 'stderr', 'verbose|v', 'utf8|u') or exit 1; pod2usage (0) if $options{help}; # Official sets --center, but don't override things explicitly set. if ($options{official} && !defined $options{center}) { $options{center} = 'Perl Programmers Reference Guide'; } # Verbose is only our flag, not a Pod::Man flag. my $verbose = $options{verbose}; delete $options{verbose}; # This isn't a valid Pod::Man option and is only accepted for backward # compatibility. delete $options{lax}; # Initialize and run the formatter, pulling a pair of input and output off at # a time. my $parser = Pod::Man->new (%options); my @files; do { @files = splice (@ARGV, 0, 2); print " $files[1]\n" if $verbose; $parser->parse_from_file (@files); } while (@ARGV); __END__ =head1 NAME pod2man - Convert POD data to formatted *roff input =for stopwords en em --stderr stderr --utf8 UTF-8 overdo markup MT-LEVEL Allbery Solaris URL troff troff-specific formatters uppercased Christiansen =head1 SYNOPSIS pod2man [B<--center>=I<string>] [B<--date>=I<string>] [B<--fixed>=I<font>] [B<--fixedbold>=I<font>] [B<--fixeditalic>=I<font>] [B<--fixedbolditalic>=I<font>] [B<--name>=I<name>] [B<--official>] [B<--quotes>=I<quotes>] [B<--release>[=I<version>]] [B<--section>=I<manext>] [B<--stderr>] [B<--utf8>] [B<--verbose>] [I<input> [I<output>] ...] pod2man B<--help> =head1 DESCRIPTION B<pod2man> is a front-end for Pod::Man, using it to generate *roff input from POD source. The resulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1), or printing using troff(1). I<input> is the file to read for POD source (the POD can be embedded in code). If I<input> isn't given, it defaults to C<STDIN>. I<output>, if given, is the file to which to write the formatted output. If I<output> isn't given, the formatted output is written to C<STDOUT>. Several POD files can be processed in the same B<pod2man> invocation (saving module load and compile times) by providing multiple pairs of I<input> and I<output> files on the command line. B<--section>, B<--release>, B<--center>, B<--date>, and B<--official> can be used to set the headers and footers to use; if not given, Pod::Man will assume various defaults. See below or L<Pod::Man> for details. B<pod2man> assumes that your *roff formatters have a fixed-width font named C<CW>. If yours is called something else (like C<CR>), use B<--fixed> to specify it. This generally only matters for troff output for printing. Similarly, you can set the fonts used for bold, italic, and bold italic fixed-width output. Besides the obvious pod conversions, Pod::Man, and therefore pod2man also takes care of formatting func(), func(n), and simple variable references like $foo or @bar so you don't have to use code escapes for them; complex expressions like C<$fred{'stuff'}> will still need to be escaped, though. It also translates dashes that aren't used as hyphens into en dashes, makes long dashes--like this--into proper em dashes, fixes "paired quotes," and takes care of several other troff-specific tweaks. See L<Pod::Man> for complete information. =head1 OPTIONS =over 4 =item B<-c> I<string>, B<--center>=I<string> Sets the centered page header to I<string>. The default is "User Contributed Perl Documentation", but also see B<--official> below. =item B<-d> I<string>, B<--date>=I<string> Set the left-hand footer string to this value. By default, the modification date of the input file will be used, or the current date if input comes from C<STDIN>. =item B<--fixed>=I<font> The fixed-width font to use for verbatim text and code. Defaults to C<CW>. Some systems may want C<CR> instead. Only matters for troff(1) output. =item B<--fixedbold>=I<font> Bold version of the fixed-width font. Defaults to C<CB>. Only matters for troff(1) output. =item B<--fixeditalic>=I<font> Italic version of the fixed-width font (actually, something of a misnomer, since most fixed-width fonts only have an oblique version, not an italic version). Defaults to C<CI>. Only matters for troff(1) output. =item B<--fixedbolditalic>=I<font> Bold italic (probably actually oblique) version of the fixed-width font. Pod::Man doesn't assume you have this, and defaults to C<CB>. Some systems (such as Solaris) have this font available as C<CX>. Only matters for troff(1) output. =item B<-h>, B<--help> Print out usage information. =item B<-l>, B<--lax> No longer used. B<pod2man> used to check its input for validity as a manual page, but this should now be done by L<podchecker(1)> instead. Accepted for backward compatibility; this option no longer does anything. =item B<-n> I<name>, B<--name>=I<name> Set the name of the manual page to I<name>. Without this option, the manual name is set to the uppercased base name of the file being converted unless the manual section is 3, in which case the path is parsed to see if it is a Perl module path. If it is, a path like C<.../lib/Pod/Man.pm> is converted into a name like C<Pod::Man>. This option, if given, overrides any automatic determination of the name. Note that this option is probably not useful when converting multiple POD files at once. The convention for Unix man pages for commands is for the man page title to be in all-uppercase even if the command isn't. =item B<-o>, B<--official> Set the default header to indicate that this page is part of the standard Perl release, if B<--center> is not also given. =item B<-q> I<quotes>, B<--quotes>=I<quotes> Sets the quote marks used to surround CE<lt>> text to I<quotes>. If I<quotes> is a single character, it is used as both the left and right quote; if I<quotes> is two characters, the first character is used as the left quote and the second as the right quoted; and if I<quotes> is four characters, the first two are used as the left quote and the second two as the right quote. I<quotes> may also be set to the special value C<none>, in which case no quote marks are added around CE<lt>> text (but the font is still changed for troff output). =item B<-r>, B<--release> Set the centered footer. By default, this is the version of Perl you run B<pod2man> under. Note that some system an macro sets assume that the centered footer will be a modification date and will prepend something like "Last modified: "; if this is the case, you may want to set B<--release> to the last modified date and B<--date> to the version number. =item B<-s>, B<--section> Set the section for the C<.TH> macro. The standard section numbering convention is to use 1 for user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6 for games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot of variation here, however; some systems (like Solaris) use 4 for file formats, 5 for miscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix of both. About the only section numbers that are reliably consistent are 1, 2, and 3. By default, section 1 will be used unless the file ends in C<.pm>, in which case section 3 will be selected. =item B<--stderr> By default, B<pod2man> puts any errors detected in the POD input in a POD ERRORS section in the output manual page. If B<--stderr> is given, errors are sent to standard error instead and the POD ERRORS section is suppressed. =item B<-u>, B<--utf8> By default, B<pod2man> produces the most conservative possible *roff output to try to ensure that it will work with as many different *roff implementations as possible. Many *roff implementations cannot handle non-ASCII characters, so this means all non-ASCII characters are converted either to a *roff escape sequence that tries to create a properly accented character (at least for troff output) or to C<X>. This option says to instead output literal UTF-8 characters. If your *roff implementation can handle it, this is the best output format to use and avoids corruption of documents containing non-ASCII characters. However, be warned that *roff source with literal UTF-8 characters is not supported by many implementations and may even result in segfaults and other bad behavior. Be aware that, when using this option, the input encoding of your POD source must be properly declared unless it is US-ASCII or Latin-1. POD input without an C<=encoding> command will be assumed to be in Latin-1, and if it's actually in UTF-8, the output will be double-encoded. See L<perlpod(1)> for more information on the C<=encoding> command. =item B<-v>, B<--verbose> Print out the name of each output file as it is being generated. =back =head1 DIAGNOSTICS If B<pod2man> fails with errors, see L<Pod::Man> and L<Pod::Simple> for information about what those errors might mean. =head1 EXAMPLES pod2man program > program.1 pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3 pod2man --section=7 note.pod > note.7 If you would like to print out a lot of man page continuously, you probably want to set the C and D registers to set contiguous page numbering and even/odd paging, at least on some versions of man(7). troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ... To get index entries on C<STDERR>, turn on the F register, as in: troff -man -rF1 perl.1 The indexing merely outputs messages via C<.tm> for each major page, section, subsection, item, and any C<XE<lt>E<gt>> directives. See L<Pod::Man> for more details. =head1 BUGS Lots of this documentation is duplicated from L<Pod::Man>. =head1 NOTES For those not sure of the proper layout of a man page, here are some notes on writing a proper man page. The name of the program being documented is conventionally written in bold (using BE<lt>E<gt>) wherever it occurs, as are all program options. Arguments should be written in italics (IE<lt>E<gt>). Functions are traditionally written in italics; if you write a function as function(), Pod::Man will take care of this for you. Literal code or commands should be in CE<lt>E<gt>. References to other man pages should be in the form C<manpage(section)>, and Pod::Man will automatically format those appropriately. As an exception, it's traditional not to use this form when referring to module documentation; use C<LE<lt>Module::NameE<gt>> instead. References to other programs or functions are normally in the form of man page references so that cross-referencing tools can provide the user with links and the like. It's possible to overdo this, though, so be careful not to clutter your documentation with too much markup. The major headers should be set out using a C<=head1> directive, and are historically written in the rather startling ALL UPPER CASE format, although this is not mandatory. Minor headers may be included using C<=head2>, and are typically in mixed case. The standard sections of a manual page are: =over 4 =item NAME Mandatory section; should be a comma-separated list of programs or functions documented by this POD page, such as: foo, bar - programs to do something Manual page indexers are often extremely picky about the format of this section, so don't put anything in it except this line. A single dash, and only a single dash, should separate the list of programs or functions from the description. Functions should not be qualified with C<()> or the like. The description should ideally fit on a single line, even if a man program replaces the dash with a few tabs. =item SYNOPSIS A short usage summary for programs and functions. This section is mandatory for section 3 pages. =item DESCRIPTION Extended description and discussion of the program or functions, or the body of the documentation for man pages that document something else. If particularly long, it's a good idea to break this up into subsections C<=head2> directives like: =head2 Normal Usage =head2 Advanced Features =head2 Writing Configuration Files or whatever is appropriate for your documentation. =item OPTIONS Detailed description of each of the command-line options taken by the program. This should be separate from the description for the use of things like L<Pod::Usage|Pod::Usage>. This is normally presented as a list, with each option as a separate C<=item>. The specific option string should be enclosed in BE<lt>E<gt>. Any values that the option takes should be enclosed in IE<lt>E<gt>. For example, the section for the option B<--section>=I<manext> would be introduced with: =item B<--section>=I<manext> Synonymous options (like both the short and long forms) are separated by a comma and a space on the same C<=item> line, or optionally listed as their own item with a reference to the canonical name. For example, since B<--section> can also be written as B<-s>, the above would be: =item B<-s> I<manext>, B<--section>=I<manext> (Writing the short option first is arguably easier to read, since the long option is long enough to draw the eye to it anyway and the short option can otherwise get lost in visual noise.) =item RETURN VALUE What the program or function returns, if successful. This section can be omitted for programs whose precise exit codes aren't important, provided they return 0 on success as is standard. It should always be present for functions. =item ERRORS Exceptions, error return codes, exit statuses, and errno settings. Typically used for function documentation; program documentation uses DIAGNOSTICS instead. The general rule of thumb is that errors printed to C<STDOUT> or C<STDERR> and intended for the end user are documented in DIAGNOSTICS while errors passed internal to the calling program and intended for other programmers are documented in ERRORS. When documenting a function that sets errno, a full list of the possible errno values should be given here. =item DIAGNOSTICS All possible messages the program can print out--and what they mean. You may wish to follow the same documentation style as the Perl documentation; see perldiag(1) for more details (and look at the POD source as well). If applicable, please include details on what the user should do to correct the error; documenting an error as indicating "the input buffer is too small" without telling the user how to increase the size of the input buffer (or at least telling them that it isn't possible) aren't very useful. =item EXAMPLES Give some example uses of the program or function. Don't skimp; users often find this the most useful part of the documentation. The examples are generally given as verbatim paragraphs. Don't just present an example without explaining what it does. Adding a short paragraph saying what the example will do can increase the value of the example immensely. =item ENVIRONMENT Environment variables that the program cares about, normally presented as a list using C<=over>, C<=item>, and C<=back>. For example: =over 6 =item HOME Used to determine the user's home directory. F<.foorc> in this directory is read for configuration details, if it exists. =back Since environment variables are normally in all uppercase, no additional special formatting is generally needed; they're glaring enough as it is. =item FILES All files used by the program or function, normally presented as a list, and what it uses them for. File names should be enclosed in FE<lt>E<gt>. It's particularly important to document files that will be potentially modified. =item CAVEATS Things to take special care with, sometimes called WARNINGS. =item BUGS Things that are broken or just don't work quite right. =item RESTRICTIONS Bugs you don't plan to fix. :-) =item NOTES Miscellaneous commentary. =item AUTHOR Who wrote it (use AUTHORS for multiple people). Including your current e-mail address (or some e-mail address to which bug reports should be sent) so that users have a way of contacting you is a good idea. Remember that program documentation tends to roam the wild for far longer than you expect and pick an e-mail address that's likely to last if possible. =item HISTORY Programs derived from other sources sometimes have this, or you might keep a modification log here. If the log gets overly long or detailed, consider maintaining it in a separate file, though. =item COPYRIGHT AND LICENSE For copyright Copyright YEAR(s) by YOUR NAME(s) (No, (C) is not needed. No, "all rights reserved" is not needed.) For licensing the easiest way is to use the same licensing as Perl itself: This library is free software; you may redistribute it and/or modify it under the same terms as Perl itself. This makes it easy for people to use your module with Perl. Note that this licensing is neither an endorsement or a requirement, you are of course free to choose any licensing. =item SEE ALSO Other man pages to check out, like man(1), man(7), makewhatis(8), or catman(8). Normally a simple list of man pages separated by commas, or a paragraph giving the name of a reference work. Man page references, if they use the standard C<name(section)> form, don't have to be enclosed in LE<lt>E<gt> (although it's recommended), but other things in this section probably should be when appropriate. If the package has a mailing list, include a URL or subscription instructions here. If the package has a web site, include a URL here. =back In addition, some systems use CONFORMING TO to note conformance to relevant standards and MT-LEVEL to note safeness for use in threaded programs or signal handlers. These headings are primarily useful when documenting parts of a C library. Documentation of object-oriented libraries or modules may use CONSTRUCTORS and METHODS sections for detailed documentation of the parts of the library and save the DESCRIPTION section for an overview; other large modules may use FUNCTIONS for similar reasons. Some people use OVERVIEW to summarize the description if it's quite long. Section ordering varies, although NAME should I<always> be the first section (you'll break some man page systems otherwise), and NAME, SYNOPSIS, DESCRIPTION, and OPTIONS generally always occur first and in that order if present. In general, SEE ALSO, AUTHOR, and similar material should be left for last. Some systems also move WARNINGS and NOTES to last. The order given above should be reasonable for most purposes. Finally, as a general note, try not to use an excessive amount of markup. As documented here and in L<Pod::Man>, you can safely leave Perl variables, function names, man page references, and the like unadorned by markup and the POD translators will figure it out for you. This makes it much easier to later edit the documentation. Note that many existing translators (including this one currently) will do the wrong thing with e-mail addresses when wrapped in LE<lt>E<gt>, so don't do that. For additional information that may be more accurate for your specific system, see either L<man(5)> or L<man(7)> depending on your system manual section numbering conventions. =head1 SEE ALSO L<Pod::Man>, L<Pod::Simple>, L<man(1)>, L<nroff(1)>, L<perlpod(1)>, L<podchecker(1)>, L<troff(1)>, L<man(7)> The man page documenting the an macro set may be L<man(5)> instead of L<man(7)> on your system. The current version of this script is always available from its web site at L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the Perl core distribution as of 5.6.0. =head1 AUTHOR Russ Allbery <rra@stanford.edu>, based I<very> heavily on the original B<pod2man> by Larry Wall and Tom Christiansen. Large portions of this documentation, particularly the sections on the anatomy of a proper man page, are taken from the B<pod2man> documentation by Tom. =head1 COPYRIGHT AND LICENSE Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery <rra@stanford.edu>. This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself. =cut
Save
cmd:
run