aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-28 07:44:54 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-28 07:44:54 +0200
commit28acf7dbae3733afedd895035c6a053aa4d69f8b (patch)
treeb6d85ed024d12177f5df20b952f47347ebed8828 /doc
parent03e4e1a8bde0a53404af45e36e2f69df80d92ef8 (diff)
Move to common man prologues and epilogues
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/cli.sh16
-rw-r--r--doc/epilogue.17
-rw-r--r--doc/epilogue.xhtml11
l---------doc/man-epilogue.11
l---------doc/man-epilogue.xhtml1
l---------doc/man-prologue.11
l---------doc/man-prologue.xhtml1
-rw-r--r--doc/prologue.16
-rw-r--r--doc/prologue.xhtml118
m---------doc/style0
10 files changed, 13 insertions, 149 deletions
diff --git a/doc/cli.sh b/doc/cli.sh
index 8422e7c..83aefdc 100755
--- a/doc/cli.sh
+++ b/doc/cli.sh
@@ -33,13 +33,15 @@ function compile ()
shift
done
- cli -I .. -v version="$version" -v date="$date" --include-base-last "${o[@]}" \
---generate-html --html-prologue-file prologue.xhtml --html-epilogue-file \
-epilogue.xhtml --html-suffix .xhtml ../bpkg/$n.cli
-
- cli -I .. -v version="$version" -v date="$date" --include-base-last "${o[@]}" \
---generate-man --man-prologue-file prologue.1 --man-epilogue-file epilogue.1 \
---man-suffix .1 ../bpkg/$n.cli
+ cli -I .. -v project="bpkg" -v version="$version" -v date="$date" \
+--include-base-last "${o[@]}" --generate-html --html-prologue-file \
+man-prologue.xhtml --html-epilogue-file man-epilogue.xhtml --html-suffix \
+.xhtml ../bpkg/$n.cli
+
+ cli -I .. -v project="bpkg" -v version="$version" -v date="$date" \
+--include-base-last "${o[@]}" --generate-man --man-prologue-file \
+man-prologue.1 --man-epilogue-file man-epilogue.1 --man-suffix .1 \
+../bpkg/$n.cli
}
o="--output-prefix bpkg- --class-doc bpkg::common_options=short"
diff --git a/doc/epilogue.1 b/doc/epilogue.1
deleted file mode 100644
index 584f1c0..0000000
--- a/doc/epilogue.1
+++ /dev/null
@@ -1,7 +0,0 @@
-.SH BUGS
-Send bug reports to the @@ mailing list.
-.SH COPYRIGHT
-Copyright (c) 2014-2016 Code Synthesis Ltd
-
-Permission is granted to copy, distribute and/or modify this document under
-the terms of the MIT License.
diff --git a/doc/epilogue.xhtml b/doc/epilogue.xhtml
deleted file mode 100644
index a835371..0000000
--- a/doc/epilogue.xhtml
+++ /dev/null
@@ -1,11 +0,0 @@
- <h1>BUGS</h1>
-
- <p>Send bug reports to the <a href="mailto:@@">@@</a> mailing list.</p>
-
-</div>
-
-<div id="footer">&#169; 2014-2016 Code Synthesis Ltd<br/>
- Distributed under the terms of the MIT License</div>
-
-</body>
-</html>
diff --git a/doc/man-epilogue.1 b/doc/man-epilogue.1
new file mode 120000
index 0000000..878a9ae
--- /dev/null
+++ b/doc/man-epilogue.1
@@ -0,0 +1 @@
+style/man-epilogue.1 \ No newline at end of file
diff --git a/doc/man-epilogue.xhtml b/doc/man-epilogue.xhtml
new file mode 120000
index 0000000..6c1722a
--- /dev/null
+++ b/doc/man-epilogue.xhtml
@@ -0,0 +1 @@
+style/man-epilogue.xhtml \ No newline at end of file
diff --git a/doc/man-prologue.1 b/doc/man-prologue.1
new file mode 120000
index 0000000..08b5b4b
--- /dev/null
+++ b/doc/man-prologue.1
@@ -0,0 +1 @@
+style/man-prologue.1 \ No newline at end of file
diff --git a/doc/man-prologue.xhtml b/doc/man-prologue.xhtml
new file mode 120000
index 0000000..34997e3
--- /dev/null
+++ b/doc/man-prologue.xhtml
@@ -0,0 +1 @@
+style/man-prologue.xhtml \ No newline at end of file
diff --git a/doc/prologue.1 b/doc/prologue.1
deleted file mode 100644
index 9a71279..0000000
--- a/doc/prologue.1
+++ /dev/null
@@ -1,6 +0,0 @@
-.\" Process this file with
-.\" groff -man -Tascii $name$.$section$
-.\"
-.TH $name$ $section$ "$date$" "bpkg $version$"
-.SH NAME
-\fB$name$\fR \- $summary$
diff --git a/doc/prologue.xhtml b/doc/prologue.xhtml
deleted file mode 100644
index e3ef036..0000000
--- a/doc/prologue.xhtml
+++ /dev/null
@@ -1,118 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
- <meta charset="UTF-8"/>
- <title>$name$($section$) bpkg $version$</title>
-
- <!-- @@ Need to style default ul, ol -->
-
- <style type="text/css">
- html
- {
- font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
- font-weight: normal;
- font-size: 18px;
- line-height: 1.4em;
-
- color: #333;
- text-align: justify;
- }
-
- body {margin: 0;}
- body {min-width: 17em;}
- @media only screen and (min-width: 360px)
- {
- body {min-width: 19em;}
- }
-
- #content
- {
- max-width: 40em;
- margin: 0 auto 0 auto;
- padding: 0 .4em 0 1.5em;
- }
-
- #footer
- {
- color: #666;
- font-size: 0.833em;
- line-height: 1.3em;
- text-align: center;
- margin: 2.2em 0 1em 0;
- }
-
- h1
- {
- font-weight: normal;
- font-size: 1.58em;
- line-height: 1.4em;
-
- margin: 1.6em 0 .6em -.92em;
- }
-
- code, pre
- {
- font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
- font-size: 0.92em;
- }
-
- /*
- code
- {
- background-color: rgba(0, 0, 0, 0.04);
- border-radius: 0.2em;
- padding: .2em 0 .2em 0;
- }
-
- code::before
- {
- letter-spacing: -0.2em;
- content: "\00a0";
- }
-
- code::after
- {
- letter-spacing: -0.2em;
- content: "\00a0";
- }
- */
-
- pre
- {
- background-color: #f7f7f7;
- border-radius: 0.2em;
- padding: .8em .4em .8em .4em;
- margin: .2em -.4em .2em -.4em; /* Use margins of #content. */
- }
-
- dl {
- margin: 1em 0 1em 0;
- }
-
- dl dt {
- margin: 0 0 0 0;
- }
-
- dl dd {
- margin: 0 0 0 1.8em;
- }
-
- .options {
- margin: 1em 0 1em 0;
- }
-
- .options dt {
- margin: 1em 0 0 0;
- }
-
- .options dd {
- margin: .1em 0 0 4.5em;
- }
- </style>
-</head>
-<body>
-<div id="content">
-
- <h1>NAME</h1>
-
- <p><b><code>$name$</code></b> &#8211; $summary$</p>
diff --git a/doc/style b/doc/style
-Subproject 0cba359075afacb16e1e05393a4f2836a9c5dc9
+Subproject 60fec06053818e32e97b028fa1d4d1085fd1e67