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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
#!/bin/sh
# This script generates a manpage from the mksquashfs -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 mksquashfs> <output file>"
exit 1
fi
# Sanity check, ensure $1 points to a directory with a runnable Mksquashfs
if [ ! -x $1/mksquashfs ]; then
error "$0: <arg1> doesn't point to a directory with Mksquashfs in it!"
error "$0: <arg1> should point to the directory with the Mksquashfs" \
"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 expand 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 mksquashfs -help, expand TABS to spaces, and output the help text to
# $tmp/mksquashfs.help. This is to allow it to be modified before
# passing to help2man.
if ! $1/mksquashfs -help > $tmp/mksquashfs.help2 2>&1; then
error "$0: Running Mksquashfs failed. Cross-compiled or incompatible binary?"
exit 1
fi
expand $tmp/mksquashfs.help2 > $tmp/mksquashfs.help
# Run mksquashfs -version, and output the version text to
# $tmp/mksquashfs.version. This is to allow it to be modified before
# passing to help2man.
$1/mksquashfs -version > $tmp/mksquashfs.version
# Create a dummy executable in $tmp, which outputs $tmp/mksquashfs.help
# and $tmp/mksquashfs.version. This gets around the fact help2man wants
# to pass --help and --version directly to mksquashfs, rather than take the
# (modified) output from $tmp/mksquashfs.help and $tmp/mksquashfs.version
print "#!/bin/sh
if [ \$1 = \"--help\" ]; then
cat $tmp/mksquashfs.help
else
cat $tmp/mksquashfs.version
fi" > $tmp/mksquashfs.sh
chmod u+x $tmp/mksquashfs.sh
# help2man gets confused by the version date returned by -version,
# and includes it in the version string
sed -i "s/ (.*)$//" $tmp/mksquashfs.version
# help2man expects copyright to have an upper-case C ...
sed -i "s/^copyright/Copyright/" $tmp/mksquashfs.version
# help2man doesn't pick up the author from the version. Easiest to add
# it here.
print >> $tmp/mksquashfs.version
print "Written by Phillip Lougher <phillip@squashfs.org.uk>" >> $tmp/mksquashfs.version
# help2man expects "Usage: ", and so rename "SYNTAX:" to "Usage: "
sed -i "s/^SYNTAX:/Usage: /" $tmp/mksquashfs.help
# The Usage text expands over two lines, and that confuses help2man.
# So concatenate the lines if the second isn't empty
sed -i "/^Usage/ {
N
/\n$/b
s/\n/ /
}" $tmp/mksquashfs.help
# Man pages expect the options to be in the "Options" section. So insert
# Options section after Usage
sed -i "/^Usage/a *OPTIONS*" $tmp/mksquashfs.help
# help2man expects options to start in the 2nd column
sed -i "s/^-/ -/" $tmp/mksquashfs.help
sed -i "s/^ *-X/ -X/" $tmp/mksquashfs.help
# help2man expects the options usage to be separated from the
# option and operands text by at least 2 spaces.
sed -i -e "s/expr> as/expr> as/" -e "s/exp> as/exp> as/" -e "s/file> as/file> as/" -e "s/regex> exclude/regex> exclude/" -e "s/regex> include/regex> include/" $tmp/mksquashfs.help
# Expand certain operands truncated in help text due to lack of space
sed -i -e "s/act@/action@/g" -e "s/expr>/expression>/g" -e "s/exp>/expression>/" -e "s/<f>/<file>/g" $tmp/mksquashfs.help
# Uppercase the options operands (between < and > ) to make it conform
# more to man page standards
sed -i "s/<[^>]*>/\U&/g" $tmp/mksquashfs.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/mksquashfs.help
# help2man doesn't deal well with the list of supported compressors.
# So concatenate them onto one line with commas
sed -i "/^ -comp/ {
N
s/\n */. /
s/:/: /
N
s/\n *\([^ ]*$\)/\1/
s/\n *\([^ ]* (default)$\)/\1/
: again
N
/\n -noI/b
s/\n *\([^ ]*$\)/, \1/
s/\n *\([^ ]* (default)$\)/, \1/
b again
}" $tmp/mksquashfs.help
# help2man doesn't deal well with the list of lzo1* algorithms.
# So concatenate them onto one line with commas
sed -i "/^ *lzo1x_1/ {
s/\n *\([^ ]*$\)/\1/
s/\n *\([^ ]* (default)$\)/\1/
: again
N
/\n *lzo/!b
s/\n *\([^ ]*$\)/, \1/
s/\n *\([^ ]* (default)$\)/, \1/
b again
}" $tmp/mksquashfs.help
# Make the pseudo file definitions into "options" so they're handled
# properly by help2man
sed -i "s/^\"filename/ -p \"filename/" $tmp/mksquashfs.help
# Make each compressor entry in the compressors available section, a subsection
# First, have to deal with the deprecated lzma compressor separately, because
# it doesn't have any options (i.e. text prefixed with -).
sed -i "/^ *lzma/ {
s/^ *\(lzma.*$\)/\1:/
n
s/^ */ /
} " $tmp/mksquashfs.help
# Now deal with the others
sed -i -e "s/^ *\(gzip.*$\)/\1:/" -e "s/^ *\(lzo$\)/\1:/" \
-e "s/^ *\(lzo (default)$\)/\1:/" -e "s/^ *\(lz4.*$\)/\1:/" \
-e "s/^ *\(xz.*$\)/\1:/" -e "s/^ *\(zstd.*$\)/\1:/" \
$tmp/mksquashfs.help
# Concatenate the options text (normal options, pseudo file definitions and
# compressor options) on to one line. Add a full stop to the end of the
# options text
sed -i "/^ -/ {
:option
s/^ *-/ -/
/ -.* /!s/.$/& /
:again
N
/\n$/b print
/\n[^ ]/b print
/\n -/b print
s/\n */ /
b again
:print
s/ \n/.\n/
s/\([^.]\)\n/\1.\n/
P
s/^.*\n//
/^ *-/b option
}" $tmp/mksquashfs.help
# Concatenate the SOURCE_DATE_EPOCH text on to one line. Indent the line by
# two and add a full stop to the end of the line
sed -i " /SOURCE_DATE_EPOCH/ {
s/SOURCE_DATE_EPOCH/ SOURCE_DATE_EPOCH/
:again
N
/\n$/b print
s/\n */ /
b again
:print
s/\([^.]\)\n/\1.\n/
}" $tmp/mksquashfs.help
# Make Compressors available header into a manpage section
sed -i "s/\(Compressors available and compressor specific options\):/*\1*/" $tmp/mksquashfs.help
# Make pseudo definition format header into a manpage section
sed -i "s/\(Pseudo file definition format\):/*\1*/" $tmp/mksquashfs.help
# Add reference to manpages for other squashfs-tools programs
sed -i "s/See also:/See also:\nunsquashfs(1), sqfstar(1), sqfscat(1)\n/" $tmp/mksquashfs.help
# Make See also header into a manpage section
sed -i "s/\(See also\):/*\1*/" $tmp/mksquashfs.help
# Make Environment header into a manpage section
sed -i "s/\(Environment\):/*\1*/" $tmp/mksquashfs.help
if ! help2man -Ni mksquashfs.h2m -o $2 $tmp/mksquashfs.sh; then
error "$0: help2man returned error. Aborting"
exit 1
fi
rm -rf $tmp
|
