aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/Makefile2
-rw-r--r--docs/gs-ctan.84
-rw-r--r--docs/gs-ctan.8.rst4
-rw-r--r--docs/gs-elpa.84
-rw-r--r--docs/gs-elpa.8.rst4
-rw-r--r--docs/gs-pypi.8153
-rw-r--r--docs/gs-pypi.8.rst4
7 files changed, 164 insertions, 11 deletions
diff --git a/docs/Makefile b/docs/Makefile
index b876790..cba7bc8 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,7 +1,7 @@
HTML_SOURCES=developer_instructions
HTML_DOCS=$(HTML_SOURCES:=.html)
-MAN_SOURCES=g-sorcery g-sorcery.cfg gs-elpa gs-ctan
+MAN_SOURCES=g-sorcery g-sorcery.cfg gs-elpa gs-pypi gs-ctan
MANS=$(MAN_SOURCES:=.8)
RST2HTML=rst2html.py
diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8
index 23c93b2..8c456be 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-ctan.8
@@ -52,8 +52,8 @@ There are two ways of using \fBgs\-ctan\fP:
.IP \(bu 2
use it with \fBlayman\fP
.sp
-In this case all you need to do is install \fBlayman\-9999\fP, \fBg\-sorcery\fP
-and \fBgs\-ctan\fP. Then you should just run \fIlayman \-L\fP as
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
root and find an overlay you want. Type of overlay will be
displayed as \fIg\-sorcery\fP. Then you add this overlay as
usual. It\(aqs all you need to do and it\(aqs the recommended way of
diff --git a/docs/gs-ctan.8.rst b/docs/gs-ctan.8.rst
index 578b519..348617e 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-ctan.8.rst
@@ -38,8 +38,8 @@ There are two ways of using **gs-ctan**:
* use it with **layman**
- In this case all you need to do is install **layman-9999**, **g-sorcery**
- and **gs-ctan**. Then you should just run `layman -L` as
+ In this case all you need to do is install **layman-9999** and **g-sorcery**.
+ 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
diff --git a/docs/gs-elpa.8 b/docs/gs-elpa.8
index a1ba281..cd71794 100644
--- a/docs/gs-elpa.8
+++ b/docs/gs-elpa.8
@@ -53,8 +53,8 @@ There are two ways of using \fBgs\-elpa\fP:
.IP \(bu 2
use it with \fBlayman\fP
.sp
-In this case all you need to do is install \fBlayman\-9999\fP, \fBg\-sorcery\fP
-and \fBgs\-elpa\fP. Then you should just run \fIlayman \-L\fP as
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
root and find an overlay you want. Type of overlay will be
displayed as \fIg\-sorcery\fP. Then you add this overlay as
usual. It\(aqs all you need to do and it\(aqs the recommended way of
diff --git a/docs/gs-elpa.8.rst b/docs/gs-elpa.8.rst
index 7c718fa..008c30e 100644
--- a/docs/gs-elpa.8.rst
+++ b/docs/gs-elpa.8.rst
@@ -39,8 +39,8 @@ There are two ways of using **gs-elpa**:
* use it with **layman**
- In this case all you need to do is install **layman-9999**, **g-sorcery**
- and **gs-elpa**. Then you should just run `layman -L` as
+ In this case all you need to do is install **layman-9999** and **g-sorcery**.
+ 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
diff --git a/docs/gs-pypi.8 b/docs/gs-pypi.8
new file mode 100644
index 0000000..633de7d
--- /dev/null
+++ b/docs/gs-pypi.8
@@ -0,0 +1,153 @@
+.\" Man page generated from reStructuredText.
+.
+.TH GS-PYPI 8 "2013-08-04" "0.1" "g-sorcery"
+.SH NAME
+gs-pypi \- manage overlays for PYPI repository
+.
+.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
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP
+.sp
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP
+.sp
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP
+.sp
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP \fIPACKAGE\fP
+.sp
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP]
+.SH DESCRIPTION
+.sp
+\fBgs\-pypi\fP is an ebuild generator for PYPI PYTHON repository.
+.sp
+There are two ways of using \fBgs\-pypi\fP:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+use it with \fBlayman\fP
+.sp
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
+root and find an overlay you want. Type of overlay will be
+displayed as \fIg\-sorcery\fP. Then you add this overlay as
+usual. It\(aqs all you need to do and it\(aqs the recommended way of
+using \fBgs\-pypi\fP.
+.IP \(bu 2
+use it as stand\-alone tool
+.sp
+In this case you should create an overlay (see \fBportage\fP documentation), sync it and populate
+it with one or more ebuilds. Then ebuilds could be installed by emerge or by \fBgs\-pypi\fP tool.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \fB\-\-overlay\fP \fIOVERLAY\fP, \fB\-o\fP \fIOVERLAY\fP
+Overlay directory. This option is mandatory if there is no
+\fBdefault_overlay\fP entry in a backend config.
+.TP
+.B \fB\-\-repository\fP \fIREPO\fP, \fB\-r\fP \fIREPO\fP
+Repository name. This option is not mandatory. If present should be \fBctan\fP.
+.UNINDENT
+.SH COMMANDS
+.INDENT 0.0
+.TP
+.B \fBsync\fP
+Synchronize a repository database.
+.TP
+.B \fBlist\fP
+List packages available in a repository.
+.TP
+.B \fBgenerate\fP
+Generate a given ebuild and all its dependencies.
+.TP
+.B \fBinstall\fP
+Generate and install an ebuild using your package mangler.
+.TP
+.B \fBgenerate\-tree\fP
+Generate entire overlay structure. Without option \fB\-d\fP after
+this command sources are not fetched during generation and there
+are no entries for them in Manifest files.
+.UNINDENT
+.SH FILES
+.INDENT 0.0
+.TP
+.B \fB/etc/g\-sorcery/gs\-pypi.json\fP
+Backend config.
+.TP
+.B \fB/etc/layman/overlays/gs\-pypi\-overlays.xml\fP
+List of available repositories.
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.TP
+.B Using gs\-pypi with layman
+Execute
+.sp
+\fBlayman \-L\fP
+.sp
+If you see there a \fBpypi\fP overlay then anything should work.
+.sp
+\fBlayman \-a pypi\fP
+.sp
+Emerge any package from it using \fBemerge\fP.
+.TP
+.B Generating user ebuilds in user overlay
+Create new user overlay. Run
+.sp
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBsync\fP
+.sp
+List packages:
+.sp
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBlist\fP
+.sp
+Install any package you want:
+.sp
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBinstall\fP \fIPACKAGE\fP
+.sp
+Note, that if you call \fBgenerate\-tree\fP command your overlay
+will be wiped and overlay tree for a given repository will be generated. Be careful!
+.UNINDENT
+.SH NOTES
+.INDENT 0.0
+.IP 1. 3
+At the moment the only package mangler \fBgs\-pypi\fP supports is \fBportage\fP.
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fBgs\-elpa\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
+by Brian Dolbec.
+.SH COPYRIGHT
+Copyright (c) 2013 Jauhien Piatlicki, License: GPL-2
+.\" Generated by docutils manpage writer.
+.
diff --git a/docs/gs-pypi.8.rst b/docs/gs-pypi.8.rst
index 560a94c..d5c7c07 100644
--- a/docs/gs-pypi.8.rst
+++ b/docs/gs-pypi.8.rst
@@ -38,8 +38,8 @@ 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
+ In this case all you need to do is install **layman-9999** and **g-sorcery**.
+ 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