docs/g-sorcery.cfg: man page added

10 files changed, 141 insertions, 8 deletions

diff --git a/README.md b/README.md
index 8efc4f5..0e26fb6 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ using **g-sorcery**.
 Using **g-sorcery** with layman you can populate overlay only with packages you want.
 To do so you should add a section named BACKEND (BACKEND here is the name of backend used for
 your repo). In this section you can add entries named REPO_packages (REPO here is the name
-of repository you want to add) which are space separated list of packages you need. ebuilds for
+of repository you want to add) which are space separated lists of packages you need. ebuilds for
 dependencies will be generated automatically if backend supports this possibility.
 
 Note, that some overlays may depend on other overlays, in this case you'll need to add those
diff --git a/docs/Makefile b/docs/Makefile
index 19b6458..b876790 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,7 +1,7 @@
 HTML_SOURCES=developer_instructions
 HTML_DOCS=$(HTML_SOURCES:=.html)
 
-MAN_SOURCES=g-sorcery gs-elpa gs-ctan
+MAN_SOURCES=g-sorcery g-sorcery.cfg gs-elpa gs-ctan
 MANS=$(MAN_SOURCES:=.8)
 
 RST2HTML=rst2html.py
diff --git a/docs/g-sorcery.8 b/docs/g-sorcery.8
index ebd0afb..c810d57 100644
--- a/docs/g-sorcery.8
+++ b/docs/g-sorcery.8
@@ -127,7 +127,7 @@ At the moment the only package mangler \fBg\-sorcery\fP supports is \fBportage\f
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBg\-sorcery.cfg\fP(8), \fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements
diff --git a/docs/g-sorcery.8.rst b/docs/g-sorcery.8.rst
index ca529c7..72f6338 100644
--- a/docs/g-sorcery.8.rst
+++ b/docs/g-sorcery.8.rst
@@ -112,4 +112,4 @@ NOTES
 SEE ALSO
 ========
 
-**gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/g-sorcery.cfg.8 b/docs/g-sorcery.cfg.8
new file mode 100644
index 0000000..bc55811
--- /dev/null
+++ b/docs/g-sorcery.cfg.8
@@ -0,0 +1,74 @@
+.\" Man page generated from reStructuredText.
+.
+.TH G-SORCERY.CFG 8 "2013-09-20" "0.1" "g-sorcery"
+.SH NAME
+g-sorcery.cfg \- custom settings for g-sorcery
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+\fB/etc/g\-sorcery/g\-sorcery.cfg\fP
+.SH DESCRIPTION
+.sp
+\fBg\-sorcery.cfg\fP various \fBg\-sorcery\fP settings aimed to be changeable by user.
+.SH SECTIONS AND VARIABLES
+.SS [main]
+.sp
+Section with common settings. Contains only one variable: \fIpackage_manager\fP.
+Currently it only can have value \fIportage\fP.
+.SS [BACKEND]
+.sp
+Section with settings for a given backend. \fBBACKEND\fP should be a backend name.
+It can contain entries named \fBREPO_packages\fP with a list of space separated names
+of packages which ebuilds should be generated for. \fBREPO\fP is a name of a repository.
+.SH EXAMPLE
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+[main]
+package_manager=portage
+
+[gs\-elpa]
+marmalade_packages = clojure\-mode clojurescript\-mode
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fBg\-sorcery\fP(8), \fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+.SH AUTHOR
+Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
+and mentorship by Rafael Martins. Lots of help and improvements
+by Brian Dolbec.
+.SH COPYRIGHT
+Copyright (c) 2013 Jauhien Piatlicki, License: GPL-2
+.\" Generated by docutils manpage writer.
+.
diff --git a/docs/g-sorcery.cfg.8.rst b/docs/g-sorcery.cfg.8.rst
new file mode 100644
index 0000000..2a3b18a
--- /dev/null
+++ b/docs/g-sorcery.cfg.8.rst
@@ -0,0 +1,59 @@
+=============
+g-sorcery.cfg
+=============
+
+-----------------------------
+custom settings for g-sorcery
+-----------------------------
+
+:Author: Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
+	 and mentorship by Rafael Martins. Lots of help and improvements
+	 by Brian Dolbec.
+:Date:   2013-09-20
+:Copyright: Copyright (c) 2013 Jauhien Piatlicki, License: GPL-2
+:Version: 0.1
+:Manual section: 8
+:Manual group: g-sorcery
+
+
+SYNOPSIS
+========
+
+**/etc/g-sorcery/g-sorcery.cfg**
+
+DESCRIPTION
+===========
+
+**g-sorcery.cfg** various **g-sorcery** settings aimed to be changeable by user.
+
+SECTIONS AND VARIABLES
+======================
+
+\[main\]
+~~~~~~~~
+Section with common settings. Contains only one variable: *package_manager*.
+Currently it only can have value *portage*.
+
+\[BACKEND\]
+~~~~~~~~~~~
+Section with settings for a given backend. **BACKEND** should be a backend name.
+It can contain entries named **REPO_packages** with a list of space separated names
+of packages which ebuilds should be generated for. **REPO** is a name of a repository.
+
+
+EXAMPLE
+=======
+
+.. code-block::
+
+ [main]
+ package_manager=portage
+
+ [gs-elpa]
+ marmalade_packages = clojure-mode clojurescript-mode
+
+
+SEE ALSO
+========
+
+**g-sorcery**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8
index 8663647..1cbe225 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-ctan.8
@@ -142,7 +142,7 @@ At the moment the only package mangler \fBgs\-ctan\fP supports is \fBportage\fP.
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBgs\-elpa\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-elpa\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements
diff --git a/docs/gs-ctan.8.rst b/docs/gs-ctan.8.rst
index e11be9b..68a749d 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-ctan.8.rst
@@ -127,4 +127,4 @@ NOTES
 SEE ALSO
 ========
 
-**gs-elpa**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/gs-elpa.8 b/docs/gs-elpa.8
index c64afee..2a3dfde 100644
--- a/docs/gs-elpa.8
+++ b/docs/gs-elpa.8
@@ -154,7 +154,7 @@ recommended way of using gs\-elpa is using it with layman. Even doing so you sho
 gnu\-elpa repository: \fBlayman \-a gnu\-elpa\fP.
 .SH SEE ALSO
 .sp
-\fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-ctan\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements
diff --git a/docs/gs-elpa.8.rst b/docs/gs-elpa.8.rst
index 4c38cb9..1104ef2 100644
--- a/docs/gs-elpa.8.rst
+++ b/docs/gs-elpa.8.rst
@@ -141,4 +141,4 @@ gnu-elpa repository: **layman -a gnu-elpa**.
 SEE ALSO
 ========
 
-**gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)