#!/usr/bin/python3
-# This script takes a manpage written in github-flavored markdown and turns it
-# into a html web page and a nroff man page. The input file must have the name
-# of the program and the section in the format: NAME.NUM.md. The output files
-# are written into the current directory named NAME.NUM.html and NAME.NUM. The
-# input format has one extra extension: if a numbered list starts at 0, it is
-# turned into a description list. The dl's dt tag is taken from the contents of
-# the first tag inside the li, which is usually a p tag or a code tag. The
-# cmarkgfm lib is used to transforms the input file into html. The html.parser
-# is used as a state machine that both tweaks the html and outputs the nroff
-# data based on the html tags.
+# This script takes a manpage written in markdown and turns it into an html web
+# page and a nroff man page. The input file must have the name of the program
+# and the section in this format: NAME.NUM.md. The output files are written
+# into the current directory named NAME.NUM.html and NAME.NUM. The input
+# format has one extra extension: if a numbered list starts at 0, it is turned
+# into a description list. The dl's dt tag is taken from the contents of the
+# first tag inside the li, which is usually a p, code, or strong tag. The
+# cmarkgfm or commonmark lib is used to transforms the input file into html.
+# The html.parser is used as a state machine that both tweaks the html and
+# outputs the nroff data based on the html tags.
#
# Copyright (C) 2020 Wayne Davison
#
HTML_START = """\
<html><head>
<title>%s</title>
-<link href="https://fonts.googleapis.com/css2?family=Roboto&display=swap" rel="stylesheet">
+<link href="https://fonts.googleapis.com/css2?family=Roboto&family=Roboto+Mono&display=swap" rel="stylesheet">
<style>
body {
- max-width: 40em;
+ max-width: 50em;
margin: auto;
font-size: 1.2em;
+}
+body, b, strong, u {
font-family: 'Roboto', sans-serif;
}
+code {
+ font-family: 'Roboto Mono', monospace;
+ font-weight: bold;
+}
+pre code {
+ display: block;
+ font-weight: normal;
+}
blockquote pre code {
- background: #eee;
+ background: #f1f1f1;
}
dd p:first-of-type {
margin-block-start: 0em;
"""
MAN_START = r"""
-.TH "%s" "%s" "%s" "" ""
+.TH "%s" "%s" "%s" "%s" "User Commands"
""".lstrip()
MAN_END = """\
BOLD_FONT = ('\2', r"\fB")
ULIN_FONT = ('\3', r"\fI")
+md_parser = None
+
def main():
fi = re.match(r'^(?P<fn>(?P<srcdir>.+/)?(?P<name>(?P<prog>[^/]+)\.(?P<sect>\d+))\.md)$', args.mdfile)
if not fi:
break
with open(fi.fn, 'r', encoding='utf-8') as fh:
- txt = re.sub(r'@VERSION@', env_subs['VERSION'], fh.read())
- txt = re.sub(r'@LIBDIR@', env_subs['libdir'], txt)
- fi.html_in = cmarkgfm.github_flavored_markdown_to_html(txt)
- txt = None
+ txt = fh.read()
+
+ txt = re.sub(r'@VERSION@', env_subs['VERSION'], txt)
+ txt = re.sub(r'@LIBDIR@', env_subs['libdir'], txt)
+ fi.html_in = md_parser(txt)
+ txt = None
+
+ fi.man_headings = (fi.prog, fi.sect, fi.date, fi.prog + ' ' + env_subs['VERSION'])
HtmlToManPage(fi)
with open(fn, 'w', encoding='utf-8') as fh:
fh.write(txt)
+def html_via_cmarkgfm(txt):
+ return cmarkgfm.markdown_to_html(txt)
+
+
+def html_via_commonmark(txt):
+ return commonmark.HtmlRenderer().render(commonmark.Parser().parse(txt))
+
class HtmlToManPage(HTMLParser):
def __init__(self, fi):
dt_from = None,
in_pre = False,
html_out = [ HTML_START % fi.title ],
- man_out = [ MAN_START % (fi.prog, fi.sect, fi.date) ],
+ man_out = [ MAN_START % fi.man_headings ],
txt = '',
)
st.man_out.append(st.p_macro + ".nf\n")
elif tag == 'code' and not st.in_pre:
st.txt += BOLD_FONT[0]
- elif tag == 'strong' or tag == 'bold':
+ elif tag == 'strong' or tag == 'b':
st.txt += BOLD_FONT[0]
- elif tag == 'i' or tag == 'em':
+ elif tag == 'em' or tag == 'i':
+ tag = 'u' # Change it into underline to be more like the man page
st.txt += ULIN_FONT[0]
elif tag == 'ol':
start = 1
st.in_pre = False
st.man_out.append(manify(txt) + "\n.fi\n")
elif tag == 'code' and not st.in_pre:
- add_to_txt = NORM_FONT[0]
- elif tag == 'strong' or tag == 'bold':
- add_to_txt = NORM_FONT[0]
- elif tag == 'i' or tag == 'em':
- add_to_txt = NORM_FONT[0]
+ add_to_txt = NORM_FONT[0]
+ elif tag == 'strong' or tag == 'b':
+ add_to_txt = NORM_FONT[0]
+ elif tag == 'em' or tag == 'i':
+ tag = 'u' # Change it into underline to be more like the man page
+ add_to_txt = NORM_FONT[0]
elif tag == 'ol' or tag == 'ul':
if st.list_state.pop() == 'dl':
tag = 'dl'
try:
import cmarkgfm
+ md_parser = html_via_cmarkgfm
except:
- die("The cmarkgfm library is not available for python3.")
+ try:
+ import commonmark
+ md_parser = html_via_commonmark
+ except:
+ die("Failed to find cmarkgfm or commonmark for python3.")
main()
see also the comments on the `--delete` option
-Please report bugs! See the web site at http://rsync.samba.org/
+Please report bugs! See the web site at <http://rsync.samba.org/>.
# VERSION
rsync is distributed under the GNU General Public License. See the file
COPYING for details.
-A WEB site is available at http://rsync.samba.org/ . The
-site includes an FAQ-O-Matic which may cover questions unanswered by this
-manual page.
+A web site is available at <http://rsync.samba.org/>. The site includes an
+FAQ-O-Matic which may cover questions unanswered by this manual page.
-The primary ftp site for rsync is ftp://rsync.samba.org/pub/rsync .
+The primary ftp site for rsync is <ftp://rsync.samba.org/pub/rsync>
-We would be delighted to hear from you if you like this program.
-Please contact the mailing-list at rsync@lists.samba.org.
+We would be delighted to hear from you if you like this program. Please
+contact the mailing-list at <rsync@lists.samba.org>.
-This program uses the excellent zlib compression library written by
-Jean-loup Gailly and Mark Adler.
+This program uses the excellent zlib compression library written by Jean-loup
+Gailly and Mark Adler.
# THANKS
David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our
gone-but-not-forgotten compadre, J.W. Schultz.
-Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
-and David Bell. I've probably missed some people, my apologies if I have.
+Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell and
+David Bell. I've probably missed some people, my apologies if I have.
# AUTHOR
-rsync was originally written by Andrew Tridgell and Paul Mackerras.
-Many people have later contributed to it. It is currently maintained
-by Wayne Davison.
+rsync was originally written by Andrew Tridgell and Paul Mackerras. Many
+people have later contributed to it. It is currently maintained by Wayne
+Davison.
Mailing lists for support and development are available at
-http://lists.samba.org .
+<http://lists.samba.org/>.
git.samba.org / rsync.git / commitdiff