summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-08-15 15:33:30 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-08-15 15:33:30 -0400
commita44049946703f614690cb95c899733fcbc560dd1 (patch)
treefaf19827dedc20f1327c14de31964520bb0275ee /doc
parent387fffc9ebdcb52b31fcbafba0faafef261b93eb (diff)
downloadbcfg2-a44049946703f614690cb95c899733fcbc560dd1.tar.gz
bcfg2-a44049946703f614690cb95c899733fcbc560dd1.tar.bz2
bcfg2-a44049946703f614690cb95c899733fcbc560dd1.zip
updated docs to reflect deprecation of info/:info
Diffstat (limited to 'doc')
-rw-r--r--doc/appendix/files/ntp.txt2
-rw-r--r--doc/server/info.txt62
-rw-r--r--doc/server/plugins/generators/sshbase.txt4
3 files changed, 42 insertions, 26 deletions
diff --git a/doc/appendix/files/ntp.txt b/doc/appendix/files/ntp.txt
index 38d5e2208..e14816f6e 100644
--- a/doc/appendix/files/ntp.txt
+++ b/doc/appendix/files/ntp.txt
@@ -56,7 +56,7 @@ a client, a profile group, a list of packages, and an NTP bundle.
</PackageList>
(This can also be performed more elegantly with the
-:ref:`server-plugins-generators-pacakges` plugin.)
+:ref:`server-plugins-generators-packages` plugin.)
Add service
-----------
diff --git a/doc/server/info.txt b/doc/server/info.txt
index eea819b7e..5c2279b73 100644
--- a/doc/server/info.txt
+++ b/doc/server/info.txt
@@ -11,15 +11,16 @@ Various file properties for entries served by the :ref:`Cfg
<server-plugins-generators-tgenshi-index>`, :ref:`TCheetah
<server-plugins-generators-tcheetah>`, and :ref:`SSHbase
<server-plugins-generators-sshbase>` plugins are controlled through
-the use of ``:info``, ``info``, or ``info.xml`` files.
+the use of ``info.xml`` files.
By default, these plugins are set to write files to the filesystem
with owner **root**, group **root**, and mode **644** (read and write
for owner, read only for group and other). These options, and a few
-others, can be overridden through use of ``info.xml``, ``:info``, or
-``info`` files. Each config file directory can have a ``info.xml``,
-``:info`` or ``info`` file if needed. The possible fields in an info
-file are:
+others, can be overridden through use of ``info.xml`` files. Each
+config file directory can have a ``info.xml`` file if needed.
+
+An ``info.xml`` file consists of a ``<FileInfo>`` tag containing an
+``<Info>`` tag; the following attributes are allowed on the ``<Info>`` tag:
+------------+-------------------+----------------------------------+---------+
| Field | Possible values | Description | Default |
@@ -51,13 +52,7 @@ file are:
| | | reports | |
+------------+-------------------+----------------------------------+---------+
-A sample info file for CGI script on a web server might look like::
-
- owner: www
- group: www
- perms: 0755
-
-The equivalent ``info.xml`` file would be:
+A sample info file for CGI script on a web server might look like:
.. code-block:: xml
@@ -77,17 +72,13 @@ might look like::
See :ref:`server-selinux` for more information on the ``secontext``
attribute and managing SELinux in general.
-.. _server-info-info-xml:
-
-info.xml files
-==============
-
-``info.xml`` files add the ability to specify different sets of file
-metadata on a group by group or host by host basis, or by path (for
-files using :ref:`altsrc <server-plugins-structures-altsrc>`). These
-files are XML, and work similarly to those used by :ref:`Rules
-<server-plugins-generators-rules>` or :ref:`Pkgmgr
-<server-plugins-generators-pkgmgr>`.
+``info.xml`` files also have the ability to specify different sets of
+file metadata on a group by group or host by host basis, or by path
+(for files using :ref:`altsrc
+<server-plugins-structures-altsrc>`). These files are XML, and work
+similarly to those used by :ref:`Rules
+<server-plugins-generators-rules>` or :ref:`Bundler
+<server-plugins-structures-bundler-index>`.
The following specifies a different global set of permissions
(root/sys/0651) than on clients in group webserver or named
@@ -122,3 +113,28 @@ of permissions depending on the path of the file::
You can also specify ACLs as children of ``<Info>`` tags in
``info.xml``. See :ref:`server-plugins-generators-rules-acls` for
more information on the formatting of ACL tags.
+
+:info and info files
+====================
+
+Historically, Bcfg2 also accepted the use of ``:info`` and ``info``
+files, which function the same as ``info.xml``, but are not XML. They
+lack the ability to specify different permissions based on client,
+group, or path, and cannot be used to specify ACLs, either.
+
+.. note::
+
+ ``:info`` and ``info`` files are deprecated and will be removed in
+ a future release.
+
+An example ``:info`` or ``info`` file would look like::
+
+ owner: www
+ group: www
+ perms: 0755
+
+All attributes allowed on the ``<Info>`` tag of an ``info.xml`` file
+can be used in an ``:info`` or ``info`` file.
+
+You should not use more than one ``:info``, ``info``, or ``info.xml``
+file for a single entry.
diff --git a/doc/server/plugins/generators/sshbase.txt b/doc/server/plugins/generators/sshbase.txt
index e6d51a335..b62a4a454 100644
--- a/doc/server/plugins/generators/sshbase.txt
+++ b/doc/server/plugins/generators/sshbase.txt
@@ -125,8 +125,8 @@ Permissions and Metadata
.. versionadded:: 1.2.0
-SSHbase supports use of an :ref:`info.xml <server-info-info-xml>` file
-to control the permissions and other metadata for the keys and
+SSHbase supports use of an :ref:`info.xml <server-info>` file to
+control the permissions and other metadata for the keys and
``ssh_known_hosts`` file. You can use the ``<Path>`` directive in
``info.xml`` to change the metadata for different keys, e.g.::