diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/developer_instructions.html | 2 | ||||
| -rw-r--r-- | docs/developer_instructions.rst | 2 | ||||
| -rw-r--r-- | docs/g-sorcery.8 | 2 | ||||
| -rw-r--r-- | docs/g-sorcery.8.rst | 2 | ||||
| -rw-r--r-- | docs/g-sorcery.cfg.8 | 2 | ||||
| -rw-r--r-- | docs/g-sorcery.cfg.8.rst | 2 | ||||
| -rw-r--r-- | docs/gs-ctan.8 | 153 | ||||
| -rw-r--r-- | docs/gs-ctan.8.rst | 130 | ||||
| -rw-r--r-- | docs/gs-pypi.8 | 2 | ||||
| -rw-r--r-- | docs/gs-pypi.8.rst | 2 |
11 files changed, 9 insertions, 292 deletions
diff --git a/docs/Makefile b/docs/Makefile index 8af5b2c..5c25523 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-pypi gs-ctan +MAN_SOURCES=g-sorcery g-sorcery.cfg gs-pypi MANS=$(MAN_SOURCES:=.8) RST2HTML=rst2html.py diff --git a/docs/developer_instructions.html b/docs/developer_instructions.html index a9798cb..f4e89ab 100644 --- a/docs/developer_instructions.html +++ b/docs/developer_instructions.html @@ -943,7 +943,7 @@ that quacks like this class.</p> <p>Before doing it you should have defined classes you pass to it as parameters. They should be database generator, two ebuild generators, eclass and metadata generators.</p> <p>Also you should write an executable that calls g-sorcery and some configs.</p> -<p>To have better understanding you can look at gs-elpa, gs-ctan and gs-pypi backends available +<p>To have better understanding you can look at gs-elpa and gs-pypi backends available in g-sorcery repository. Also available tests could be usefull.</p> <p>Note that there is a tool for editing generated database named <strong>gs-db-tool</strong>.</p> </div> diff --git a/docs/developer_instructions.rst b/docs/developer_instructions.rst index b54adfa..de266b9 100644 --- a/docs/developer_instructions.rst +++ b/docs/developer_instructions.rst @@ -634,7 +634,7 @@ generator, two ebuild generators, eclass and metadata generators. Also you should write an executable that calls g-sorcery and some configs. -To have better understanding you can look at gs-elpa, gs-ctan and gs-pypi backends available +To have better understanding you can look at gs-elpa and gs-pypi backends available in g-sorcery repository. Also available tests could be usefull. Note that there is a tool for editing generated database named **gs-db-tool**. diff --git a/docs/g-sorcery.8 b/docs/g-sorcery.8 index 1122fde..066e35b 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\-pypi\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), \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 121b571..9ea702f 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-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) +**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) diff --git a/docs/g-sorcery.cfg.8 b/docs/g-sorcery.cfg.8 index 0f11180..1643315 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\-pypi\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), \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 50a732c..7f9790f 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-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) +**g-sorcery**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8 deleted file mode 100644 index 8c456be..0000000 --- a/docs/gs-ctan.8 +++ /dev/null @@ -1,153 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH GS-CTAN 8 "2013-08-04" "0.1" "g-sorcery" -.SH NAME -gs-ctan \- manage overlays for CTAN 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\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP -.sp -\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP -.sp -\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP -.sp -\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP \fIPACKAGE\fP -.sp -\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP] -.SH DESCRIPTION -.sp -\fBgs\-ctan\fP is an ebuild generator for CTAN TEXLIVE repository. -.sp -There are two ways of using \fBgs\-ctan\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\-ctan\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\-ctan\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\-ctan.json\fP -Backend config. -.TP -.B \fB/etc/layman/overlays/gs\-ctan\-overlays.xml\fP -List of available repositories. -.UNINDENT -.SH EXAMPLES -.INDENT 0.0 -.TP -.B Using gs\-ctan with layman -Execute -.sp -\fBlayman \-L\fP -.sp -If you see there a \fBctan\fP overlay then anything should work. -.sp -\fBlayman \-a ctan\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\-ctan \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBsync\fP -.sp -List packages: -.sp -\fBgs\-ctan \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBlist\fP -.sp -Install any package you want: -.sp -\fBgs\-ctan \-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\-ctan\fP supports is \fBportage\fP. -.UNINDENT -.SH SEE ALSO -.sp -\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 -by Brian Dolbec. -.SH COPYRIGHT -Copyright (c) 2013 Jauhien Piatlicki, License: GPL-2 -.\" Generated by docutils manpage writer. -. diff --git a/docs/gs-ctan.8.rst b/docs/gs-ctan.8.rst deleted file mode 100644 index 348617e..0000000 --- a/docs/gs-ctan.8.rst +++ /dev/null @@ -1,130 +0,0 @@ -======= -gs-ctan -======= - ------------------------------------ -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 - 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-ctan** **-o** *OVERLAY* [**-r** *REPO*] **sync** - -**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **list** - -**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **generate** *PACKAGE* - -**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **install** *PACKAGE* - -**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **generate-tree** [**-d**] - -DESCRIPTION -=========== - -**gs-ctan** is an ebuild generator for CTAN TEXLIVE repository. - -There are two ways of using **gs-ctan**: - - * use it with **layman** - - 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 - using **gs-ctan**. - - * 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-ctan** 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-ctan.json** - Backend config. - -**/etc/layman/overlays/gs-ctan-overlays.xml** - List of available repositories. - -EXAMPLES -======== - -Using gs-ctan with layman - Execute - - **layman -L** - - If you see there a **ctan** overlay then anything should work. - - **layman -a ctan** - - Emerge any package from it using **emerge**. - -Generating user ebuilds in user overlay - Create new user overlay. Run - - **gs-ctan -o** *OVERLAY_DIRECTORY* **-r ctan** **sync** - - List packages: - - **gs-ctan -o** *OVERLAY_DIRECTORY* **-r ctan** **list** - - Install any package you want: - - **gs-ctan -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-ctan** supports is **portage**. - -SEE ALSO -======== - -**gs-pypi**\(8), **gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) diff --git a/docs/gs-pypi.8 b/docs/gs-pypi.8 index 633de7d..7536605 100644 --- a/docs/gs-pypi.8 +++ b/docs/gs-pypi.8 @@ -142,7 +142,7 @@ 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) +\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-pypi.8.rst b/docs/gs-pypi.8.rst index d5c7c07..92031cc 100644 --- a/docs/gs-pypi.8.rst +++ b/docs/gs-pypi.8.rst @@ -127,4 +127,4 @@ NOTES SEE ALSO ======== -**gs-elpa**\(8), **gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) +**gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8) |