diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2016-02-11 12:35:31 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2016-02-11 12:35:31 +0200 |
commit | 1b60fb26391e6645d18ddb8e42fb3d41de398a78 (patch) | |
tree | 46ea0989cf69ed1dada58016614d3657f4a5b628 /doc | |
parent | 64eec8ee5c9d4592b08d6f177b375ff62f4c1e07 (diff) |
Setup manual infra
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.gitignore | 3 | ||||
l--------- | doc/a4.html2ps | 1 | ||||
-rw-r--r-- | doc/buildfile | 21 | ||||
-rwxr-xr-x | doc/cli.sh | 19 | ||||
l--------- | doc/code-box.css | 1 | ||||
l--------- | doc/doc-epilogue.xhtml | 1 | ||||
l--------- | doc/doc-prologue.xhtml | 1 | ||||
l--------- | doc/doc.css | 1 | ||||
l--------- | doc/doc.html2ps | 1 | ||||
l--------- | doc/letter.html2ps | 1 | ||||
-rw-r--r-- | doc/manual.cli | 25 | ||||
m--------- | doc/style | 0 | ||||
l--------- | doc/toc.css | 1 |
13 files changed, 71 insertions, 5 deletions
diff --git a/doc/.gitignore b/doc/.gitignore index c27d2ca..e9bbe17 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,2 +1,5 @@ brep*.xhtml brep*.1 +build2-repository-interface-manual*.ps +build2-repository-interface-manual*.pdf +build2-repository-interface-manual.xhtml diff --git a/doc/a4.html2ps b/doc/a4.html2ps new file mode 120000 index 0000000..4b31c06 --- /dev/null +++ b/doc/a4.html2ps @@ -0,0 +1 @@ +style/a4.html2ps
\ No newline at end of file diff --git a/doc/buildfile b/doc/buildfile index bd3440f..00f9554 100644 --- a/doc/buildfile +++ b/doc/buildfile @@ -12,8 +12,19 @@ css{*}: extension = css define xhtml: doc xhtml{*}: extension = xhtml -./: {man1 xhtml}{$cmds} \ - css{common pre-box man} \ - file{man-prologue.1 man-epilogue.1 \ - man-prologue.xhtml man-epilogue.xhtml \ - cli.sh} +./: {man1 xhtml}{$cmds} \ + css{common pre-box man} \ + file{man-prologue.1 man-epilogue.1 \ + man-prologue.xhtml man-epilogue.xhtml} + +./: doc{build2-repository-interface-manual.xhtml \ + build2-repository-interface-manual-a4.pdf \ + build2-repository-interface-manual-a4.ps \ + build2-repository-interface-manual-letter.pdf \ + build2-repository-interface-manual-letter.ps} \ + css{code-box common doc pre-box toc} \ + file{a4.html2ps letter.html2ps doc.html2ps} \ + file{doc-prologue.xhtml doc-epilogue.xhtml \ + manual.cli} + +./: file{cli.sh} @@ -13,6 +13,9 @@ while [ $# -gt 0 ]; do case $1 in --clean) rm -f brep*.xhtml brep*.1 + rm -f build2-repository-interface-manual*.ps \ + build2-repository-interface-manual*.pdf \ + build2-repository-interface-manual.xhtml exit 0 ;; *) @@ -55,3 +58,19 @@ pages="load/load migrate/migrate" for p in $pages; do compile $p $o done + +# Manual. +# +cli -I .. -v version="$version" -v date="$date" \ +--generate-html --html-suffix .xhtml \ +--html-prologue-file doc-prologue.xhtml \ +--html-epilogue-file doc-epilogue.xhtml \ +--link-regex '%b([-.].+)%../../build2/doc/b$1%' \ +--link-regex '%bpkg([-.].+)%../../bpkg/doc/bpkg$1%' \ +--output-prefix build2-repository-interface- manual.cli + +html2ps -f doc.html2ps:a4.html2ps -o build2-repository-interface-manual-a4.ps build2-repository-interface-manual.xhtml +ps2pdf14 -sPAPERSIZE=a4 -dOptimize=true -dEmbedAllFonts=true build2-repository-interface-manual-a4.ps build2-repository-interface-manual-a4.pdf + +html2ps -f doc.html2ps:letter.html2ps -o build2-repository-interface-manual-letter.ps build2-repository-interface-manual.xhtml +ps2pdf14 -sPAPERSIZE=letter -dOptimize=true -dEmbedAllFonts=true build2-repository-interface-manual-letter.ps build2-repository-interface-manual-letter.pdf diff --git a/doc/code-box.css b/doc/code-box.css new file mode 120000 index 0000000..e442993 --- /dev/null +++ b/doc/code-box.css @@ -0,0 +1 @@ +style/code-box.css
\ No newline at end of file diff --git a/doc/doc-epilogue.xhtml b/doc/doc-epilogue.xhtml new file mode 120000 index 0000000..5111ca2 --- /dev/null +++ b/doc/doc-epilogue.xhtml @@ -0,0 +1 @@ +style/doc-epilogue.xhtml
\ No newline at end of file diff --git a/doc/doc-prologue.xhtml b/doc/doc-prologue.xhtml new file mode 120000 index 0000000..e1fd108 --- /dev/null +++ b/doc/doc-prologue.xhtml @@ -0,0 +1 @@ +style/doc-prologue.xhtml
\ No newline at end of file diff --git a/doc/doc.css b/doc/doc.css new file mode 120000 index 0000000..6cb3fd5 --- /dev/null +++ b/doc/doc.css @@ -0,0 +1 @@ +style/doc.css
\ No newline at end of file diff --git a/doc/doc.html2ps b/doc/doc.html2ps new file mode 120000 index 0000000..dc19855 --- /dev/null +++ b/doc/doc.html2ps @@ -0,0 +1 @@ +style/doc.html2ps
\ No newline at end of file diff --git a/doc/letter.html2ps b/doc/letter.html2ps new file mode 120000 index 0000000..607ca58 --- /dev/null +++ b/doc/letter.html2ps @@ -0,0 +1 @@ +style/letter.html2ps
\ No newline at end of file diff --git a/doc/manual.cli b/doc/manual.cli new file mode 100644 index 0000000..e8bb033 --- /dev/null +++ b/doc/manual.cli @@ -0,0 +1,25 @@ +// file : doc/manual.cli +// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd +// license : MIT; see accompanying LICENSE file + +"\name=build2-repository-interface-manual" +"\subject=repository interface" +"\title=Repository Interface" + +// NOTES +// +// - Maximum <pre> line is 70 characters. +// + +" +\h0#preface|Preface| + +This is the preface. +" + +/* +" +\h Installation +" +source "../INSTALL.cli"; +*/ diff --git a/doc/style b/doc/style -Subproject 88bef7fa19d595b64944edc38696bb1ceadba2f +Subproject e8d8ccfbd637d68f6feceace9dddc5bd5c13d83 diff --git a/doc/toc.css b/doc/toc.css new file mode 120000 index 0000000..477b331 --- /dev/null +++ b/doc/toc.css @@ -0,0 +1 @@ +style/toc.css
\ No newline at end of file |