docs/g-sorcery.8


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

.\" Man page generated from reStructuredText.
.
.TH G-SORCERY 8 "2023-02-24" "0.2.3" "g-sorcery"
.SH NAME
g-sorcery \- manage overlays for 3rd party software providers
.
.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
\fBg\-sorcery\fP \fIBACKEND\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP
.sp
\fBg\-sorcery\fP \fIBACKEND\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP
.sp
\fBg\-sorcery\fP \fIBACKEND\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP
.sp
\fBg\-sorcery\fP \fIBACKEND\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP  \fIPACKAGE\fP
.sp
\fBg\-sorcery\fP \fIBACKEND\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP]
.SH DESCRIPTION
.sp
\fBg\-sorcery\fP is aimed to provide you with easy way of integration of 3rd party software
providers with Gentoo.
.sp
3rd party software provider is a software distribution like CTAN, CPAN or ELPA.
Usualy there is a lot of software available in such a distribution and very few or no ebuilds
for it.
.sp
\fBg\-sorcery\fP is a project aimed to implement a framework for ebuild generators (backends)
for 3rd party software providers. The CLI tool g\-sorcery is designed to be called rather
by appropriate backends then by user. If you are not a backend developer and just want to
manage your overlay see documentation for a backend you want to use.
.sp
There are two ways of using \fBg\-sorcery\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, \fBg\-sorcery\fP
and appropriate backend. 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 \fBg\-sorcery\fP and backends.
.IP \(bu 2
use it as stand\-alone tool (not recommended)
.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 \fBg\-sorcery\fP tool
or backend.
.UNINDENT
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \fIBACKEND\fP
Backend to be used.
.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. If there is more than one repository available
for a given backend must be specified.
.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/g\-sorcery.cfg\fP
Main g\-sorcery config.
.TP
.B \fB/etc/g\-sorcery/*.json\fP
Backend configs.
.UNINDENT
.SH NOTES
.INDENT 0.0
.IP 1. 3
At the moment the only package mangler \fBg\-sorcery\fP supports is \fBportage\fP\&.
.UNINDENT
.SH SEE ALSO
.sp
\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
by Brian Dolbec. Integration with layman based on work of Auke Booij.
.SH COPYRIGHT
Copyright (c) 2013-2021 Jauhien Piatlicki and others,
License: GPL-2
.\" Generated by docutils manpage writer.
.