summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2012-11-06 18:00:09 -0600
committerSol Jerome <sol.jerome@gmail.com>2012-11-06 18:00:09 -0600
commit49838c53241ff5115e7965c2378b95f31d398d42 (patch)
tree488c0bbe4501977637a70d46d3b1876405a675dc /doc/man
parent2288b16ed39a281d3794345659af55e24ba30d53 (diff)
downloadbcfg2-49838c53241ff5115e7965c2378b95f31d398d42.tar.gz
bcfg2-49838c53241ff5115e7965c2378b95f31d398d42.tar.bz2
bcfg2-49838c53241ff5115e7965c2378b95f31d398d42.zip
doc: Fix paths in man pages
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/bcfg2-build-reports.txt4
-rw-r--r--doc/man/bcfg2-lint.conf.txt2
-rw-r--r--doc/man/bcfg2-lint.txt2
-rw-r--r--doc/man/bcfg2-reports.txt2
-rw-r--r--doc/man/bcfg2.conf.txt26
5 files changed, 18 insertions, 18 deletions
diff --git a/doc/man/bcfg2-build-reports.txt b/doc/man/bcfg2-build-reports.txt
index 8d859fe26..eba8244f2 100644
--- a/doc/man/bcfg2-build-reports.txt
+++ b/doc/man/bcfg2-build-reports.txt
@@ -24,14 +24,14 @@ Options
-c *configuration file*
Specify an alternate report configuration path. The default is
- `repo/etc/reports-configuration.xml`.
+ ``repo/etc/reports-configuration.xml``.
-h
Produce a help message.
-s *statistics path*
Use an alternative path for the statistics file. The default is
- `repo/etc/statistics.xml`.
+ ``repo/etc/statistics.xml``.
See Also
--------
diff --git a/doc/man/bcfg2-lint.conf.txt b/doc/man/bcfg2-lint.conf.txt
index 6e0d237ee..5b61060f4 100644
--- a/doc/man/bcfg2-lint.conf.txt
+++ b/doc/man/bcfg2-lint.conf.txt
@@ -117,7 +117,7 @@ Validate
schema
The full path to the XML Schema files. Default is
- `/usr/share/bcfg2/schema`. This can be overridden with the
+ ``/usr/share/bcfg2/schema``. This can be overridden with the
*--schema* command-line option.
See Also
diff --git a/doc/man/bcfg2-lint.txt b/doc/man/bcfg2-lint.txt
index c5d2eacee..1cfedad4e 100644
--- a/doc/man/bcfg2-lint.txt
+++ b/doc/man/bcfg2-lint.txt
@@ -37,7 +37,7 @@ Options
Be verbose.
--lint-config
- Specify path to bcfg2-lint.conf (default `/etc/bcfg2-lint.conf`).
+ Specify path to bcfg2-lint.conf (default ``/etc/bcfg2-lint.conf``).
--stdin
Rather than operating on all files in the Bcfg2 specification, only
diff --git a/doc/man/bcfg2-reports.txt b/doc/man/bcfg2-reports.txt
index f2fe72813..dbc937711 100644
--- a/doc/man/bcfg2-reports.txt
+++ b/doc/man/bcfg2-reports.txt
@@ -20,7 +20,7 @@ Description
about clients, and the states of their current interactions. It also
allows you to change the expired/unexpired states. The utility runs as a
standalone application. It does, however, use the models from
-`src/lib/Bcfg2/Reporting/models.py`.
+``src/lib/Bcfg2/Reporting/models.py``.
Options
-------
diff --git a/doc/man/bcfg2.conf.txt b/doc/man/bcfg2.conf.txt
index 1c085e0c5..9756c3891 100644
--- a/doc/man/bcfg2.conf.txt
+++ b/doc/man/bcfg2.conf.txt
@@ -63,7 +63,7 @@ ignore_files
listen_all
This setting tells the server to listen on all available interfaces.
The default is to only listen on those interfaces specified by the
- bcfg2 setting in the components section of `bcfg2.conf`.
+ bcfg2 setting in the components section of ``bcfg2.conf``.
plugins
A comma-delimited list of enabled server plugins. Currently
@@ -116,7 +116,7 @@ plugins
prefix
Specifies a prefix if the Bcfg2 installation isn't placed in the
- default location (e.g. `/usr/local`).
+ default location (e.g. ``/usr/local``).
backend
Specifies which server core backend to use. Current available
@@ -153,11 +153,11 @@ Account Plugin
The account plugin manages authentication data, including the following.
-* `/etc/passwd`
-* `/etc/group`
-* `/etc/security/limits.conf`
-* `/etc/sudoers`
-* `/root/.ssh/authorized_keys`
+* ``/etc/passwd``
+* ``/etc/group``
+* ``/etc/security/limits.conf``
+* ``/etc/sudoers``
+* ``/root/.ssh/authorized_keys``
Base Plugin
+++++++++++
@@ -510,7 +510,7 @@ Specified in the **[components]** section.
and port the server listens on. On the client, this specifies
where the client will attempt to contact the server.
- e.g. `bcfg2 = https://10.3.1.6:6789`
+ e.g. *bcfg2 = https://10.3.1.6:6789*
encoding
Text encoding of configuration files. Defaults to UTF-8.
@@ -585,7 +585,7 @@ The following options are specified in the **[packages]** section.
gpg_keypath
The path on the client where RPM GPG keys will be copied before
- they are imported on the client. Default is `/etc/pki/rpm-gpg`.
+ they are imported on the client. Default is ``/etc/pki/rpm-gpg``.
version
Set the version attribute used when binding Packages. Default is
@@ -603,7 +603,7 @@ The following options are specified in the **[packages:yum]** section.
helper
Path to bcfg2-yum-helper. By default, Bcfg2 looks first in $PATH
- and then in `/usr/sbin/bcfg2-yum-helper` for the helper.
+ and then in ``/usr/sbin/bcfg2-yum-helper`` for the helper.
The following options are specified in the **[packages:pulp]** section.
@@ -628,7 +628,7 @@ the configuration file.
path
Custom path for backups created in paranoid mode. The default is
- in `/var/cache/bcfg2`.
+ in ``/var/cache/bcfg2``.
max_copies
Specify a maximum number of copies for the server to keep when
@@ -647,7 +647,7 @@ server snapshots functionality.
database
The name of the database to use for statistics data.
- e.g.: `$REPOSITORY_DIR/etc/bcfg2.sqlite`
+ e.g.: ``$REPOSITORY_DIR/etc/bcfg2.sqlite``
SSLCA options
-------------
@@ -689,7 +689,7 @@ control the database connection of the server.
name
The name of the database to use for statistics data. If
'database_engine' is set to 'sqlite3' this is a file path to
- the sqlite file and defaults to `$REPOSITORY_DIR/etc/brpt.sqlite`.
+ the sqlite file and defaults to ``$REPOSITORY_DIR/etc/brpt.sqlite``.
user
User for database connections. Not used for sqlite3.