docs/gs-pypi: man page added

9 files changed, 142 insertions, 12 deletions

diff --git a/docs/g-sorcery.8 b/docs/g-sorcery.8
index c810d57..1122fde 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
-\fBg\-sorcery.cfg\fP(8), \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\-pypi\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 72f6338..121b571 100644
--- a/docs/g-sorcery.8.rst
+++ b/docs/g-sorcery.8.rst
@@ -112,4 +112,4 @@ NOTES
 SEE ALSO
 ========
 
-**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/g-sorcery.cfg.8 b/docs/g-sorcery.cfg.8
index bc55811..0f11180 100644
--- a/docs/g-sorcery.cfg.8
+++ b/docs/g-sorcery.cfg.8
@@ -63,7 +63,7 @@ marmalade_packages = clojure\-mode clojurescript\-mode
 .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)
+\fBg\-sorcery\fP(8), \fBgs\-elpa\fP(8), \fBgs\-pypi\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.cfg.8.rst b/docs/g-sorcery.cfg.8.rst
index 2a3b18a..50a732c 100644
--- a/docs/g-sorcery.cfg.8.rst
+++ b/docs/g-sorcery.cfg.8.rst
@@ -56,4 +56,4 @@ EXAMPLE
 SEE ALSO
 ========
 
-**g-sorcery**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**g-sorcery**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8
index 1cbe225..23c93b2 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-ctan.8
@@ -2,7 +2,7 @@
 .
 .TH GS-CTAN 8 "2013-08-04" "0.1" "g-sorcery"
 .SH NAME
-gs-ctan \- manage overlays for ELPA repositories
+gs-ctan \- manage overlays for CTAN repository
 .
 .nr rst2man-indent-level 0
 .
@@ -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), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-pypi\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 68a749d..578b519 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-ctan.8.rst
@@ -2,9 +2,9 @@
 gs-ctan
 =======
 
--------------------------------------
-manage overlays for ELPA repositories
--------------------------------------
+-----------------------------------
+manage overlays for CTAN repository
+-----------------------------------
 
 :Author: Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 	 and mentorship by Rafael Martins. Lots of help and improvements
@@ -127,4 +127,4 @@ NOTES
 SEE ALSO
 ========
 
-**gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-pypi**\(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 2a3dfde..a1ba281 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), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-pypi\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 1104ef2..7c718fa 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), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-pypi**\(8), **gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
diff --git a/docs/gs-pypi.8.rst b/docs/gs-pypi.8.rst
new file mode 100644
index 0000000..560a94c
--- /dev/null
+++ b/docs/gs-pypi.8.rst
@@ -0,0 +1,130 @@
+=======
+gs-pypi
+=======
+
+-----------------------------------
+manage overlays for PYPI repository
+-----------------------------------
+
+: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-08-04
+:Copyright: Copyright (c) 2013 Jauhien Piatlicki, License: GPL-2
+:Version: 0.1
+:Manual section: 8
+:Manual group: g-sorcery
+
+
+SYNOPSIS
+========
+
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **sync**
+
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **list**
+
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **generate** *PACKAGE*
+
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **install** *PACKAGE*
+
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **generate-tree** [**-d**]
+
+DESCRIPTION
+===========
+
+**gs-pypi** is an ebuild generator for PYPI PYTHON repository.
+
+There are two ways of using **gs-pypi**:
+
+    * use it with **layman**
+
+      In this case all you need to do is install **layman-9999**, **g-sorcery**
+      and **gs-pypi**. Then you should just run `layman -L` as
+      root and find an overlay you want. Type of overlay will be
+      displayed as *g-sorcery*. Then you add this overlay as
+      usual. It's all you need to do and it's the recommended way of
+      using **gs-pypi**.
+      
+    * use it as stand-alone tool
+
+      In this case you should create an overlay (see **portage** documentation), sync it and populate
+      it with one or more ebuilds. Then ebuilds could be installed by emerge or by **gs-pypi** tool.
+
+
+OPTIONS
+=======
+
+**--overlay** *OVERLAY*, **-o** *OVERLAY*
+    Overlay directory. This option is mandatory if there is no
+    **default_overlay** entry in a backend config.
+
+**--repository** *REPO*, **-r** *REPO*
+    Repository name. This option is not mandatory. If present should be **ctan**.
+
+COMMANDS
+========
+
+**sync**
+    Synchronize a repository database.
+
+**list**
+    List packages available in a repository.
+
+**generate**
+    Generate a given ebuild and all its dependencies.
+
+**install**
+    Generate and install an ebuild using your package mangler.
+
+**generate-tree**
+    Generate entire overlay structure. Without option **-d** after
+    this command sources are not fetched during generation and there
+    are no entries for them in Manifest files.
+
+FILES
+=====
+**/etc/g-sorcery/gs-pypi.json**
+    Backend config.
+
+**/etc/layman/overlays/gs-pypi-overlays.xml**
+    List of available repositories.
+
+EXAMPLES
+========
+
+Using gs-pypi with layman
+    Execute
+
+    **layman -L**
+
+    If you see there a **pypi** overlay then anything should work.
+
+    **layman -a pypi**
+
+    Emerge any package from it using **emerge**.
+
+Generating user ebuilds in user overlay
+    Create new user overlay. Run
+
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **sync**
+
+    List packages:
+
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **list**
+
+    Install any package you want:
+
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **install** *PACKAGE*
+
+    Note, that if you call **generate-tree** command your overlay
+    will be wiped and overlay tree for a given repository will be generated. Be careful!
+
+NOTES
+=====
+
+1. At the moment the only package mangler **gs-pypi** supports is **portage**.
+
+SEE ALSO
+========
+
+**gs-elpa**\(8), **gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)