summaryrefslogtreecommitdiffstats
path: root/doc/unsorted
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2010-12-08 19:43:54 -0600
committerSol Jerome <sol.jerome@gmail.com>2010-12-08 19:43:54 -0600
commit477c0fc85218cba12597cf3daf7728b127b0fd64 (patch)
tree0da3e2c73535cd97c22791e51e20b18b3192506c /doc/unsorted
parent9f55492d9213861c75496e6c493ad90bb5c23872 (diff)
downloadbcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.tar.gz
bcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.tar.bz2
bcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.zip
doc: Finish merging remaining documentation updates
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/unsorted')
-rw-r--r--doc/unsorted/bcfg2.conf-options.txt19
-rw-r--r--doc/unsorted/emacs_snippet.txt60
-rw-r--r--doc/unsorted/vim_snippet.txt65
-rw-r--r--doc/unsorted/writing_specification.txt4
4 files changed, 146 insertions, 2 deletions
diff --git a/doc/unsorted/bcfg2.conf-options.txt b/doc/unsorted/bcfg2.conf-options.txt
new file mode 100644
index 000000000..57e26cbd2
--- /dev/null
+++ b/doc/unsorted/bcfg2.conf-options.txt
@@ -0,0 +1,19 @@
+.. -*- mode: rst -*-
+
+.. _unsorted-bcfg2.conf-options:
+
+==========
+bcfg2.conf
+==========
+
+This page documents the various options available in bcfg2.conf. The
+various sections correspond to the sections in the file itself.
+
+components
+==========
+
+logging
+-------
+
+Specify an alternate path for the lockfile used by the bcfg2 client.
+Default value is ``/var/lock/bcfg2.run``
diff --git a/doc/unsorted/emacs_snippet.txt b/doc/unsorted/emacs_snippet.txt
new file mode 100644
index 000000000..b9f7fd25b
--- /dev/null
+++ b/doc/unsorted/emacs_snippet.txt
@@ -0,0 +1,60 @@
+.. -*- mode: rst -*-
+
+.. _unsorted-emacs_snippet:
+
+======================
+Emacs + YASnippet mode
+======================
+
+This page describes using emacs with YASnippet mode with a set of
+snippets that allow quick composition of bundles and base files.
+More snippets are under development.
+
+#. Download YASnippet from http://code.google.com/p/yasnippet/
+#. Install it into your emacs load path (typically ~/.emacs.d/site-lisp)
+#. Add YASnippet initialization to your .emacs (remember to re-byte-compile it if needed)
+
+ .. code-block:: cl
+
+ (require 'yasnippet-bundle)
+
+ ;;; Bcfg2 snippet
+
+ (yas/define-snippets 'sgml-mode
+ '(
+ ("<Bundle" "<Bundle name='${1:bundlename}' version='2.0'>
+ $0
+ </Bundle>" nil)
+ ("<Base" "<Base>
+ $0
+ </Base>" nil)
+ ("<Group" "<Group name='${1:groupname}>
+ $0
+ </Group>" nil)
+ ("<Config" "<ConfigFile name='${1:filename}'/>
+ $0" nil)
+ ("<Service" "<Service name='${1:svcname}'/>
+ $0" nil)
+ ("<Package" "<Package name='${1:packagename}'/>
+ $0" nil)
+ ("<Action" "<Action name='${1:name}'/>
+ $0" nil)
+ ("<Directory" "<Directory name='${1:name}'/>
+ $0" nil)
+ ("<SymLink" "<SymLink name='${1:name}'/>
+ $0" nil)
+ ("<Permissions" "<Permissions name='${1:name}'/>
+ $0" nil)
+ )
+ )
+
+#. One quick M-x eval-current-buffer, and this code is enabled
+
+Each of these snippets activates on the opening element, ie <Bundle.
+After this string is entered, but before entering a space, press <TAB>,
+and the snippet will be expanded. The template will be inserted into
+the text with a set of input prompts, which default to overwrite mode
+and can be tabbed through.
+
+The code above only works for bundles and base, but will be expanded
+to support other xml files as well.
diff --git a/doc/unsorted/vim_snippet.txt b/doc/unsorted/vim_snippet.txt
new file mode 100644
index 000000000..e4fda7eca
--- /dev/null
+++ b/doc/unsorted/vim_snippet.txt
@@ -0,0 +1,65 @@
+.. -*- mode: rst -*-
+
+.. _unsorted-vim_snippet:
+
+===================
+Vim Snippet Support
+===================
+
+This page describes using vim with snipMate and a set of snippets
+that allow quick composition of bundles and base files.
+
+#. Download snipMate from http://www.vim.org/scripts/script.php?script_id=2540
+#. Install it using the install instructions (unzip snipMate.zip -d ~/.vim or equivalent, e.g. $HOME\vimfiles on Windows)
+#. Add the following to ``~/.vim/snippets/xml.snippets``
+
+ .. code-block:: cl
+
+ # Bundle
+ snippet <Bundle
+ <Bundle name='${1:bundlename}'>
+ ${2}
+ </Bundle>
+ # Base
+ snippet <Base
+ <Base>
+ ${1}
+ </Base>
+ # Group
+ snippet <Group
+ <Group name='${1:groupname}'>
+ ${2}
+ </Group>
+ # ConfigFile
+ snippet <Config
+ <ConfigFile name='${1:filename}'/>
+ # Service
+ snippet <Service
+ <Service name='${1:svcname}'/>
+ # Package
+ snippet <Package
+ <Package name='${1:packagename}'/>
+ # Action
+ snippet <Action
+ <Action name='${1:name}'/>
+ # Directory
+ snippet <Directory
+ <Directory name='${1:name}'/>
+ # SymLink
+ snippet <SymLink
+ <SymLink name='${1:name}'/>
+ # Permissions
+ snippet <Permissions
+ <Permissions name='${1:name}'/>
+
+
+#. Save and start editing away!
+
+Each of these snippets activates on the opening element, ie <Bundle>.
+After this string is entered, but before entering a space, press <TAB>,
+and the snippet will be expanded. The template will be inserted into
+the text with a set of input prompts, which default to overwrite mode
+and can be tabbed through.
+
+The code above only works for bundles and base, but will be expanded
+to support other xml files as well.
diff --git a/doc/unsorted/writing_specification.txt b/doc/unsorted/writing_specification.txt
index 5a75165bf..3201067f0 100644
--- a/doc/unsorted/writing_specification.txt
+++ b/doc/unsorted/writing_specification.txt
@@ -14,8 +14,8 @@ Bcfg2 specifications are logically divided in to three areas:
The metadata portion of the configuration assigns a client to its profile
group and to its non-profile groups. The profile group is assigned
-in Metadata/clients.xml and the non profile group assignments are in
-Metadata/groups.xml.
+in ``Metadata/clients.xml`` and the non profile group assignments are in
+``Metadata/groups.xml``.
The group memberships contained in the metadata are then used to constuct
an abstract configuration for the client. An abstract configuration for