1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
#!/bin/sh
# This script generates a manpage from the unsquashfs -help and -version
# output, using help2man. The script does various modfications to the
# output from -help and -version, before passing it to help2man, to allow
# it be successfully processed into a manpage by help2man.
if [ ! -f functions.sh ]; then
echo "$0: this script should be run in the <git-root/source-root>/generate-manpages directory" >&2
exit 1
fi
. ./functions.sh
if [ $# -lt 2 ]; then
error "$0: Insufficient arguments"
error "$0: <path to unsquashfs> <output file>"
exit 1
fi
# Sanity check, ensure $1 points to a directory with a runnable Unsquashfs
if [ ! -x $1/unsquashfs ]; then
error "$0: <arg1> doesn't point to a directory with Unsquashfs in it!"
error "$0: <arg1> should point to the directory with the Unsquashfs" \
"you want to generate a manpage for."
exit 1
fi
# Sanity check, check that the utilities this script depends on, are in PATH
for i in sed help2man; do
if ! which $i > /dev/null 2>&1; then
error "$0: This script needs $i, which is not in your PATH."
error "$0: Fix PATH or install before running this script!"
exit 1
fi
done
tmp=$(mktemp -d)
# Run unsquashfs -help, and output the help text to
# $tmp/unsquashfs.help. This is to allow it to be modified before
# passing to help2man.
if ! $1/unsquashfs -help > $tmp/unsquashfs.help; then
error "$0: Running Unsquashfs failed. Cross-compiled or incompatible binary?"
exit 1
fi
# Run unsquashfs -version, and output the version text to
# $tmp/unsquashfs.version. This is to allow it to be modified before
# passing to help2man.
$1/unsquashfs -version > $tmp/unsquashfs.version
# Create a dummy executable in $tmp, which outputs $tmp/unsquashfs.help
# and $tmp/unsquashfs.version. This gets around the fact help2man wants
# to pass --help and --version directly to unsquashfs, rather than take the
# (modified) output from $tmp/unsquashfs.help and $tmp/unsquashfs.version
print "#!/bin/sh
if [ \$1 = \"--help\" ]; then
cat $tmp/unsquashfs.help
else
cat $tmp/unsquashfs.version
fi" > $tmp/unsquashfs.sh
chmod u+x $tmp/unsquashfs.sh
# help2man gets confused by the version date returned by -version,
# and includes it in the version string
sed -i "s/ (.*)$//" $tmp/unsquashfs.version
# help2man expects copyright to have an upper-case C ...
sed -i "s/^copyright/Copyright/" $tmp/unsquashfs.version
# help2man doesn't pick up the author from the version. Easiest to add
# it here.
print >> $tmp/unsquashfs.version
print "Written by Phillip Lougher <phillip@squashfs.org.uk>" >> $tmp/unsquashfs.version
# help2man expects "Usage: ", and so rename "SYNTAX:" to "Usage: "
sed -i "s/^SYNTAX:/Usage: /" $tmp/unsquashfs.help
# Man pages expect the options to be in the "Options" section. So insert
# Options section after Usage
sed -i "/^Usage/a *OPTIONS*" $tmp/unsquashfs.help
# help2man expects options to start in the 2nd column
sed -i "s/^\t-/ -/" $tmp/unsquashfs.help
# Split combined short-form/long-form options into separate short-form,
# and long form, i.e.
# -da[ta-queue] <size> becomes
# -da <size>, -data-queue <size>
sed -i "s/\([^ ][^ \[]*\)\[\([a-z-]*\)\] \(<[a-z-]*>\)/\1 \3, \1\2 \3/" $tmp/unsquashfs.help
sed -i "s/\([^ ][^ \[]*\)\[\([a-z-]*\)\]/\1, \1\2/" $tmp/unsquashfs.help
# help2man expects the options usage to be separated from the
# option and operands text by at least 2 spaces.
sed -i "s/\t/ /g" $tmp/unsquashfs.help
# Uppercase the options operands (between < and > ) to make it conform
# more to man page standards
sed -i "s/<[^>]*>/\U&/g" $tmp/unsquashfs.help
# Remove the "<" and ">" around options operands to make it conform
# more to man page standards
sed -i -e "s/<//g" -e "s/>//g" $tmp/unsquashfs.help
# help2man doesn't deal well with the list of supported compressors.
# So concatenate them onto one line with commas
sed -i "/^Decompressors available:/ {
n
s/^ //
: again
N
/\n$/b
s/\n */, /
b again
}" $tmp/unsquashfs.help
# Concatenate the options text on to one line. Add a full stop to the end of
# the options text
sed -i "/^ -/ {
:again
N
/\n$/b print
/\n -/b print
s/\n */ /
b again
:print
s/\([^.]\)\n/\1.\n/
P
s/^.*\n//
/^ -/b again
}" $tmp/unsquashfs.help
# Concatenate the exit status text on to one line.
sed -i "/^ [012]/ {
:again
N
/\n$/b print
/\n [012]/b print
s/\n */ /
b again
:print
P
s/^.*\n//
/^ [012]/b again
}" $tmp/unsquashfs.help
# Make Decompressors available header into a manpage section
sed -i "s/\(Decompressors available\):/*\1*/" $tmp/unsquashfs.help
# Make Exit status header into a manpage section
sed -i "s/\(Exit status\):/*\1*/" $tmp/unsquashfs.help
# Add reference to manpages for other squashfs-tools programs
sed -i "s/See also:/See also:\nmksquashfs(1), sqfstar(1), sqfscat(1)\n/" $tmp/unsquashfs.help
# Make See also header into a manpage section
sed -i "s/\(See also\):/*\1*/" $tmp/unsquashfs.help
if ! help2man -Ni unsquashfs.h2m -o $2 $tmp/unsquashfs.sh; then
error "$0: help2man returned error. Aborting"
exit 1
fi
rm -rf $tmp
|
