]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/txt2pre
watch: log signal activities to STDERR
[public-inbox.git] / Documentation / txt2pre
1 #!/usr/bin/env perl
2 # Copyright (C) 2014-2020 all contributors <meta@public-inbox.org>
3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 #
5 # Stupid script to make HTML from preformatted, utf-8 text versions,
6 # only generating links for http(s).  Markdown does too much
7 # and requires indentation to output preformatted text.
8 use strict;
9 use warnings;
10 use PublicInbox::Linkify;
11 use PublicInbox::Hval qw(ascii_html);
12 my %xurls;
13 for (qw[public-inbox.cgi(1)
14         public-inbox-compact(1)
15         public-inbox-config(5)
16         public-inbox-convert(1)
17         public-inbox-daemon(8)
18         public-inbox-edit(1)
19         public-inbox-httpd(1)
20         public-inbox-index(1)
21         public-inbox-init(1)
22         public-inbox-learn(1)
23         public-inbox-mda(1)
24         public-inbox-nntpd(1)
25         public-inbox-overview(7)
26         public-inbox-purge(1)
27         public-inbox-v1-format(5)
28         public-inbox-v2-format(5)
29         public-inbox-watch(1)
30         public-inbox-xcpdb(1)
31 ]) {
32         my ($n) = (/([\w\-\.]+)/);
33         $xurls{$_} = "$n.html";
34         $xurls{$n} = "$n.html";
35 }
36
37 for (qw[copydatabase(1) xapian-compact(1)]) {
38         my ($n) = (/([\w\-\.]+)/);
39         $xurls{$_} = ".$n.1.html"
40 }
41
42 for (qw[make(1) flock(2) setrlimit(2) vfork(2) tmpfs(5)]) {
43         my ($n, $s) = (/([\w\-]+)\((\d)\)/);
44         $xurls{$_} = "http://www.man7.org/linux/man-pages/man$s/$n.$s.html";
45 }
46
47 for (qw[git(1)
48         git-am(1)
49         git-apply(1)
50         git-config(1)
51         git-daemon(1)
52         git-fetch(1)
53         git-filter-branch(1)
54         git-format-patch(1)
55         git-gc(1)
56         git-http-backend(1)
57         git-imap-send(1)
58         git-init(1)
59         git-send-email(1)
60         gitrepository-layout(5)
61 ]) {
62         my ($n) = (/([\w\-\.]+)/);
63         $xurls{$_} = "https://kernel.org/pub/software/scm/git/docs/$n.html"
64 }
65
66 for (qw[
67         sd_listen_fds(3)
68         systemd(1)
69         systemd.unit(5)
70         systemd.socket(5)
71 ]) {
72         my ($n) = (/([\w\-\.]+)/);
73         $xurls{$_} = "https://www.freedesktop.org/software/systemd/man/$n.html";
74 }
75
76 $xurls{'spamc(1)'} =
77         'https://spamassassin.apache.org/full/3.4.x/doc/spamc.html';
78 $xurls{'grok-pull'} =
79         'https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git' .
80         '/tree/man/grok-pull.1.rst';
81 $xurls{'git-filter-repo(1)'} = 'https://github.com/newren/git-filter-repo'.
82                         '/blob/master/Documentation/git-filter-repo.txt';
83 $xurls{'ssoma(1)'} = 'https://ssoma.public-inbox.org/ssoma.txt';
84 $xurls{'cgitrc(5)'} = 'https://git.zx2c4.com/cgit/tree/cgitrc.5.txt';
85 $xurls{'prove(1)'} = 'https://perldoc.perl.org/prove.html';
86
87 my $str = do { local $/; <STDIN> };
88 my ($title) = ($str =~ /\A([^\n]+)/);
89 if ($str =~ /^NAME\n\s+([^\n]+)/sm) {
90         # don't link to ourselves
91         $title = $1;
92         if ($title =~ /([\w\.\-]+)/) {
93                 delete $xurls{$1};
94         }
95 }
96 $title = ascii_html($title);
97 my $l = PublicInbox::Linkify->new;
98 $str = $l->linkify_1($str);
99 $str = ascii_html($str);
100
101 # longest matches, first
102 my @keys = sort { length($b) <=> length($a) } keys %xurls;
103 my $xkeys = join('|', map { quotemeta } @keys);
104 $str =~ s,(?<![>\w_])($xkeys)(?!(?:[\w<\-]|\.html)),
105         qq(<a\nhref=").$xurls{$1}.qq(">$1).($2//'').'</a>',sge;
106
107 $str = $l->linkify_2($str);
108
109 print '<html><head>',
110   qq(<meta\nhttp-equiv="Content-Type"\ncontent="text/html; charset=utf-8"\n/>),
111   "<title>$title</title>",
112   "</head><body><pre>",  $str , '</pre></body></html>';
113 STDOUT->flush;
114
115 # keep mtime on website consistent so clients can cache
116 if (-f STDIN && -f STDOUT) {
117         my @st = stat(STDIN);
118         utime($st[8], $st[9], \*STDOUT);
119 }