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
| | #!/usr/bin/perl
#
# Author: Tomi Ollila
# License: same as notmuch
#
# This program is used to generate mdwn-formatted notmuch manual pages
# for notmuch wiki. Example run:
#
# $ ./devel/man-to-mdwn.pl doc/_build/man ../notmuch-wiki
#
# In case taken into more generic use, modify these comments and examples.
use 5.10.1;
use strict;
use warnings;
unless (@ARGV == 2) {
warn "\n$0 <source-directory> <destination-directory>\n\n";
# Remove/edit this comment if this script is taken into generic use.
warn "Example: ./devel/man-to-mdwn.pl doc/_build/man ../notmuch-wiki\n\n";
exit 1;
}
die "'$ARGV[0]': no such source directory\n" unless -d $ARGV[0];
die "'$ARGV[1]': no such destination directory\n" unless -d $ARGV[1];
#die "'manpages' exists\n" if -e 'manpages';
#die "'manpages.mdwn' exists\n" if -e 'manpages.mdwn';
die "Expecting '$ARGV[1]/manpages' to exist.\n" .
"Please create it first or adjust <destination-directory>.\n"
unless -d $ARGV[1] . '/manpages';
my $ev = 0;
my %fhash;
open P, '-|', 'find', $ARGV[0], qw/-name *.[0-9] -print/;
while (<P>)
{
chomp;
next unless -f $_; # follows symlink.
$ev = 1, warn "'$_': no such file\n" unless -f $_;
my ($in, $on) = ($_, $_);
$on =~ s|.*/||; $on =~ tr/./-/;
my $f = $fhash{$on};
$ev = 1, warn "'$in' collides with '$f' ($on.mdwn)\n" if defined $f;
$fhash{$on} = $in;
}
close P;
my %htmlqh = qw/& & < < > > ' ' " "/;
# do html quotation to $_[0] (which is an alias to the given arg)
sub htmlquote($)
{
$_[0] =~ s/([&<>'"])/$htmlqh{$1}/ge;
}
sub maymakelink($);
sub mayconvert($$);
#warn keys %fhash, "\n";
while (my ($k, $v) = each %fhash)
{
#next if -l $v; # skip symlinks here. -- not... references there may be.
my @lines;
open I, '-|', qw/env -i/, "PATH=$ENV{PATH}",
qw/TERM=vt100 LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8/,
qw/GROFF_NO_SGR=1 MAN_KEEP_FORMATTING=1 MANWIDTH=80/,
qw/man/, $v or die "$!";
binmode I, ':utf8';
my ($emptyline, $pre, $hl) = (0, 0, 'h1');
while (<I>) {
if (/^\s*$/) {
$emptyline = 1;
next;
}
# keep only leftmost in lines like 'NOTMUCH(1) notmuch NOTMUCH(1)'
s/\S\K\s{8,}\S.+\s{8,}\S.*//; # $hl = 'h1' if s/(?<=\S)\s{8,}.*//;
s/[_&]\010&/&/g;
s/((?:_\010[^_])+)/\001u\002$1\001\/u\002/g;
s/_\010(.)/$1/g;
s/((?:.\010.)+)/\001b\002$1\001\/b\002/g;
s/.\010(.)/$1/g;
htmlquote $_;
s/\001/</g; s/\002/>/g;
if (/^\S/) {
$pre = 0, push @lines, "</pre>\n" if $pre;
s/<\/?b>//g;
chomp;
$_ = "\n<$hl>$_</$hl>\n";
$hl = 'h2';
$emptyline = 0;
}
elsif (/^\s\s\s\S/) {
$pre = 0, push @lines, "</pre>\n" if $pre;
s/(?:^\s+)?<\/?b>//g;
chomp;
$_ = "\n<h3> $_</h3>\n";
$emptyline = 0;
}
else {
$pre = 1, push @lines, "<pre>\n" unless $pre;
$emptyline = 0, push @lines, "\n" if $emptyline;
}
push @lines, $_;
}
$lines[0] =~ s/^\n//;
$k = "$ARGV[1]/manpages/$k.mdwn";
open O, '>', $k or die;
binmode O, ':utf8';
print STDOUT 'Writing ', "'$k'\n";
select O;
my ($pe, $hyphen) = ('', '');
foreach (@lines) {
#print $_; next;
if ($pe) {
if (s/^(\s+)<b>([^<]+)\((\d+)\)<\/b>//) {
my $link = maymakelink "$pe-$2-$3";
$link = maymakelink "$pe$2-$3" unless $link;
if ($link) {
print "<a href='$link'>$pe$hyphen</a>\n";
print "$1<a href='$link'>$2</a>($3)";
}
else {
print "<b>$pe-</b>\n";
print "$1<b>$2</b>($3)";
}
} else {
print "<b>$pe-</b>\n";
}
$pe = '';
}
s/<b>([^<]+)\((\d+)\)<\/b>/mayconvert($1, $2)/ge;
($pe, $hyphen) = ($1, $2) if s/<b>([^<]+)([-\x{2010}])<\/b>\s*$//;
print $_;
}
}
sub maymakelink($)
{
# warn "$_[0]\n";
return "../$_[0]/" if exists $fhash{$_[0]};
return '';
}
sub mayconvert($$)
{
my $f = "$_[0]-$_[1]";
# warn "$f\n";
return "<a href='../$f/'>$_[0]</a>($_[1])" if exists $fhash{$f};
return "<b>$_[0]</b>($_[1])";
}
# Finally, make manpages.mdwn
open O, '>', $ARGV[1] . '/manpages.mdwn' or die $!;
print STDOUT "Writing '$ARGV[1]/manpages.mdwn'\n";
select O;
print "Manual page index\n";
print "=================\n\n";
sub srt { my ($x, $y) = ($a, $b); $x =~ tr/./-/; $y =~ tr/./-/; $x cmp $y; }
foreach (sort srt values %fhash)
{
my $in = $_;
open I, '<', $in or die $!;
my $s;
while (<I>) {
if (/^\s*[.]TH\s+\S+\s+"?(\S+?)"?\s/) {
$s = $1;
last;
}
}
while (<I>) {
last if /^\s*[.]SH NAME/
}
my $line = '';
while (<I>) {
tr/\\//d;
if (/\s*(\S+)\s+(.*)/) {
my $e = $2;
# Ignoring the NAME in file, get from file name instead.
#my $on = (-l $in)? readlink $in: $in;
my $on = $in;
$on =~ tr/./-/; $on =~ s|.*/||;
my $n = $in; $n =~ s|.*/||; $n =~ tr/./-/; $n =~ s/-[^-]+$//;
$line = "<a href='$on/'>$n</a>($s) $e\n";
last;
}
}
die "No NAME in '$in'\n" unless $line;
print "* $line";
#warn $line;
}
print <<'EOF';
The manual pages are licensed under
[the GNU General Public License](https://www.gnu.org/licenses/gpl.txt),
either version 3.0 or at your option any later version.
EOF
|