From 1855b3073a33874a80d64e40296050641d63cd63 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Wed, 1 Jun 2011 11:46:13 -0500 Subject: doc: add a few more escapes and fix usage of {} These addditional attributes come from the git asciidoc.conf file. Also, fix a place where we used {treename} without escaping the braces, causing the generated manpage to be missing text. Signed-off-by: Dan McGee --- doc/asciidoc.conf | 4 ++++ doc/pacman.conf.5.txt | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf index 3ea510d8..e2e72672 100644 --- a/doc/asciidoc.conf +++ b/doc/asciidoc.conf @@ -17,7 +17,11 @@ plus=+ caret=^ startsb=[ endsb=] +backslash=\ tilde=~ +apostrophe=' +backtick=` +litdd=-- ifdef::backend-docbook[] [linkman-inlinemacro] diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index bfa07458..9f1d1846 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -215,7 +215,7 @@ directory with these packages so pacman can find it when run with '\--refresh'. The above command will generate a compressed database named '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form -'{treename}.db.tar.gz', where '{treename}' is the name of the section defined in +'\{treename\}.db.tar.gz', where '\{treename\}' is the name of the section defined in the configuration file. That's it! Now configure your custom section in the configuration file as shown in the config example above. Pacman will now use your package repository. If you add new packages to the repository, remember to -- cgit v1.2.3-54-g00ecf From ac1726788c4bf9ae335df9f69f14a5f80208c413 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Wed, 1 Jun 2011 12:10:32 -0500 Subject: doc: update Makefile for new asciidoc resource location Signed-off-by: Dan McGee --- doc/Makefile.am | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 00a0e88d..afb8e8f2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -86,9 +86,9 @@ html: $(HTML_DOCS) website: html bsdtar czf website.tar.gz $(HTML_DOCS) \ -C /etc/asciidoc/stylesheets/ \ - xhtml11.css xhtml11-manpage.css xhtml11-quirks.css \ + asciidoc.css asciidoc-manpage.css \ -C /etc/asciidoc/javascripts/ \ - asciidoc-xhtml11.js \ + asciidoc.js \ -C /etc/asciidoc/ \ images -- cgit v1.2.3-54-g00ecf From aad57cc06ac60dc8fdcff9bea811e990d64f74d3 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Wed, 1 Jun 2011 12:11:31 -0500 Subject: doc: fix attribute substitution in monospaced text When I switched all paths to use `` formatting, I didn't realize substitution didn't work in these quote marks. Use ++ instead to ensure attributes are substituted where appropriate. Signed-off-by: Dan McGee --- doc/makepkg.8.txt | 2 +- doc/pacman.8.txt | 4 ++-- doc/pacman.conf.5.txt | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index c59800c6..57d6f6eb 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -53,7 +53,7 @@ Options in linkman:makepkg.conf[5]. *\--config* :: - Use an alternate config file instead of the `{sysconfdir}/makepkg.conf` + Use an alternate config file instead of the +{sysconfdir}/makepkg.conf+ default. *-d, \--nodeps*:: diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index a66bd4a9..a4d41d0e 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -117,7 +117,7 @@ Options ------- *-b, \--dbpath* :: Specify an alternative database location (a typical default is - `{localstatedir}/lib/pacman`). This should not be used unless you know what you are + +{localstatedir}/lib/pacman+). This should not be used unless you know what you are doing. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. @@ -138,7 +138,7 @@ Options *\--cachedir* :: Specify an alternative package cache location (a typical default is - `{localstatedir}/cache/pacman/pkg`). Multiple cache directories can be specified, + +{localstatedir}/cache/pacman/pkg+). Multiple cache directories can be specified, and they are tried in the order they are passed to pacman. *NOTE*: this is an absolute path, the root path is not automatically prepended. diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index 9f1d1846..dcaeed7f 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -35,7 +35,7 @@ NoUpgrade = etc/passwd etc/group etc/shadow NoUpgrade = etc/fstab [core] -Include = {sysconfdir}/pacman.d/core +Include = /etc/pacman.d/core [custom] Server = file:///home/pkgs @@ -57,13 +57,13 @@ Options *DBPath =* path/to/db/dir:: Overrides the default location of the toplevel database directory. A - typical default is `{localstatedir}/lib/pacman/`. Most users will not need to set + typical default is +{localstatedir}/lib/pacman/+. Most users will not need to set this option. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. *CacheDir =* path/to/cache/dir:: Overrides the default location of the package cache directory. A typical - default is `{localstatedir}/cache/pacman/pkg/`. Multiple cache directories can be + default is +{localstatedir}/cache/pacman/pkg/+. Multiple cache directories can be specified, and they are tried in the order they are listed in the config file. If a file is not found in any cache directory, it will be downloaded to the first cache directory with write access. *NOTE*: this is an absolute @@ -72,7 +72,7 @@ Options *LogFile =* '/path/to/file':: Overrides the default location of the pacman log file. A typical default - is `{localstatedir}/log/pacman.log`. This is an absolute path and the root directory + is +{localstatedir}/log/pacman.log+. This is an absolute path and the root directory is not prepended. *HoldPkg =* package ...:: @@ -149,7 +149,7 @@ Options *UseSyslog*:: Log action messages through syslog(). This will insert log entries into - `{localstatedir}/log/messages` or equivalent. + +{localstatedir}/log/messages+ or equivalent. *ShowSize*:: Display the size of individual packages for '\--sync' and '\--query' modes. -- cgit v1.2.3-54-g00ecf