diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/.gitignore | 4 | ||||
-rw-r--r-- | Documentation/GNUmakefile | 53 | ||||
-rw-r--r-- | Documentation/olddoc.1.txt | 21 | ||||
-rw-r--r-- | Documentation/olddoc.5.txt | 26 |
4 files changed, 104 insertions, 0 deletions
diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 0000000..c618f1a --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1,4 @@ +*.html_fragment +*.1 +*.5 +*.html diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile new file mode 100644 index 0000000..5e47833 --- /dev/null +++ b/Documentation/GNUmakefile @@ -0,0 +1,53 @@ +# Copyright (C) 2015, all contributors <olddoc-public@80x24.org> +# License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) +all:: + +INSTALL = install +PANDOC = pandoc +PANDOC_OPTS = -f markdown --email-obfuscation=none +pandoc = $(PANDOC) $(PANDOC_OPTS) +pandoc_html = $(pandoc) --toc -t html --no-wrap + + +man1 := olddoc.1 +man5 := olddoc.5 +man7 := + +html1 := $(addsuffix .html, $(man1)) +html5 := $(addsuffix .html, $(man5)) +html7 := $(addsuffix .html, $(man7)) + +all:: man + +man: $(man1) $(man5) $(man7) +html: $(html1) $(html5) $(html7) + +prefix ?= $(HOME) +mandir ?= $(prefix)/share/man +man1dir = $(mandir)/man1 +man5dir = $(mandir)/man5 +man7dir = $(mandir)/man7 + +gem-man: man + $(INSTALL) -d -m 755 ../man + test -z "$(man1)" || $(INSTALL) -m 644 $(man1) ../man + test -z "$(man5)" || $(INSTALL) -m 644 $(man5) ../man + test -z "$(man7)" || $(INSTALL) -m 644 $(man7) ../man + +install-man: man + $(INSTALL) -d -m 755 $(DESTDIR)$(mandir) + test -z "$(man1)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir) + test -z "$(man5)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir) + test -z "$(man7)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir) + test -z "$(man1)" || $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir) + test -z "$(man5)" || $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir) + test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir) + +%: %.txt + $(pandoc) -s -t man < $< > $@+ && mv $@+ $@ + +%.html : %.txt + $(pandoc_html) < $< > $@+ && mv $@+ $@ + +clean:: + $(RM) $(man1) $(man5) $(man7) $(html1) $(html5) $(html7) diff --git a/Documentation/olddoc.1.txt b/Documentation/olddoc.1.txt new file mode 100644 index 0000000..e7b31d8 --- /dev/null +++ b/Documentation/olddoc.1.txt @@ -0,0 +1,21 @@ +% olddoc(1) olddoc user manual + +# NAME + +olddoc - old-fashioned RDoc HTML generator + +# SYNOPSIS + +`olddoc` prepare + +`rdoc` -f oldweb + +# DESCRIPTION + +olddoc features oldweb, and old-fashioned RDoc HTML generator. +You can also use "olddoc prepare" to generate NEWS files from +git tags and ChangeLog entries from "git log". + +# SEE ALSO + +olddoc(5) diff --git a/Documentation/olddoc.5.txt b/Documentation/olddoc.5.txt new file mode 100644 index 0000000..0b95578 --- /dev/null +++ b/Documentation/olddoc.5.txt @@ -0,0 +1,26 @@ +% olddoc(1) olddoc user manual + +# NAME + +.olddoc.yml - olddoc config file format + +# SYNOPSIS + +A YAML file in the top-level project directory named ".olddoc.yml" + +# DESCRIPTION + +As olddoc favors consistency over configuration, there is minimal +configuration to deal with. + +# KEYS + +`rdoc_url`, `cgit_url` should be obvious + +`merge_html` is a key-value mapping of (empty) RDoc source files to an +HTML file that will be merged into RDoc after-the-fact. It is useful +for merging non-RDoc generated HTML into the project. + +# SEE ALSO + +olddoc(1) |