aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2013-10-26 18:33:28 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2013-10-26 18:33:34 +0200
commit0a48ad9f4a9382627f270065c6f756351474b7a8 (patch)
treef08e8573130fe11da05969e5c17fa2c12e94ad8a /docs
parent165d20eebc587f21f0409850b8e522c7a25979e3 (diff)
downloadapp.sh-0a48ad9f4a9382627f270065c6f756351474b7a8.tar.gz
app.sh-0a48ad9f4a9382627f270065c6f756351474b7a8.tar.bz2
app.sh-0a48ad9f4a9382627f270065c6f756351474b7a8.tar.xz
app.sh-0a48ad9f4a9382627f270065c6f756351474b7a8.zip
o Better links in HTML docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile4
-rw-r--r--docs/app-cat-conf.txt6
-rw-r--r--docs/app.txt12
-rw-r--r--docs/asciidoc.conf20
4 files changed, 30 insertions, 12 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 8b8cf8b..2a62f18 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -5,11 +5,11 @@ all: $(HTML) $(MAN)
%.html: %.txt
@echo asciidoc $<
- @asciidoc -a data-uri -a icons -a toc -a max-width=55em $<
+ @asciidoc -f asciidoc.conf --backend=html5 $<
%.1: %.txt
@echo a2x $<
- @a2x --doctype manpage --format manpage $<
+ @a2x --format manpage $<
clean:
rm -rf $(wildcard *.html) $(wildcard *.1)
diff --git a/docs/app-cat-conf.txt b/docs/app-cat-conf.txt
index 0411390..ec2c4f9 100644
--- a/docs/app-cat-conf.txt
+++ b/docs/app-cat-conf.txt
@@ -39,11 +39,11 @@ LOCATIONS AND DEFAULT FILES
'app-cat-conf' will by default look for configuration files in three places:
-. $APPSH_HOME/lib/default-config
+* '$APPSH_HOME/lib/default-config'
-. $HOME/.appconfig
+* '$HOME/.appconfig'
-. .app/config
+* '.app/config'
SEE ALSO
--------
diff --git a/docs/app.txt b/docs/app.txt
index 49ed59e..fb77174 100644
--- a/docs/app.txt
+++ b/docs/app.txt
@@ -5,7 +5,6 @@ NAME
----
app - your favorite application manager
-
SYNOPSIS
--------
[verse]
@@ -83,17 +82,16 @@ Configuration properties:
TODOs
-----
-* Consider renaming "upgrade" to "refresh". Upgrade is an overloaded
- word, in particular since it might mean to download a catalog of
- applications instead of actually upgrading it. I'm always confused
- if I should use "upgrade" or "update".
+* Consider renaming "upgrade" to "refresh" or "sync". Upgrade is an
+ overloaded word, in particular since it might mean to download a
+ catalog of applications instead of actually upgrading it. I'm always
+ confused if I should use "upgrade" or "update".
* Find a way to check if an application is running.
SEE ALSO
--------
-* app-conf
-* app-cat-conf
+linkman:app-conf[1]
// vim: set ft=asciidoc:
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
new file mode 100644
index 0000000..8622db4
--- /dev/null
+++ b/docs/asciidoc.conf
@@ -0,0 +1,20 @@
+[macros]
+(?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
+
+ifdef::backend-docbook[]
+[linkman-inlinemacro]
+{0%{target}}
+{0#<citerefentry>}
+{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
+{0#</citerefentry>}
+endif::backend-docbook[]
+
+ifdef::backend-html5[]
+
+#[attributes]
+#relative-ext=.html
+
+[linkman-inlinemacro]
+<a href="{target}.html">{target}{0?({0})}</a>
+
+endif::backend-html5[]