aboutsummaryrefslogtreecommitdiff
blob: 2a3dd376cb2b321ef52425774f19cedcad1f77f0 (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
.\" Man page generated from reStructuredText.
.
.TH GS-ELPA 8 "2014-11-22" "0.1.3" "g-sorcery"
.SH NAME
gs-elpa \- manage overlays for ELPA repositories
.
.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\-elpa\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP
.sp
\fBgs\-elpa\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP
.sp
\fBgs\-elpa\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP
.sp
\fBgs\-elpa\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP \fIPACKAGE\fP
.sp
\fBgs\-elpa\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP]
.SH DESCRIPTION
.sp
\fBgs\-elpa\fP is an ebuild generator for ELPA repositories \-\- repositories with
elisp packages for emacs.
.sp
There are two ways of using \fBgs\-elpa\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 \fBgs\-elpa\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\-elpa\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\-elpa\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. Can be one of \fBgnu\-elpa\fP, \fBmarmalade\fP,
\fBmelpa\fP, \fBmelpa\-stable\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\-elpa.json\fP
Backend config.
.TP
.B \fB/etc/layman/overlays/gs\-elpa\-overlays.xml\fP
List of available repositories.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.TP
.B Using gs\-elpa with layman
Execute
.sp
\fBlayman \-L\fP
.sp
Find there an overlay you need (there are
3 gs\-elpa overlays currently: gnu\-elpa, marmalade, melpa and melpa\-stable).
Add, e.g.
.sp
\fBlayman \-a gnu\-elpa \-a marmalade\fP
.sp
Emerge any package from it, e.g.
.sp
\fBemerge \-va clojure\-mode\fP
.TP
.B Generating ebuilds for packages that are already in the tree
Ebuilds for the packages available in the tree are excluded from
the generation. To enable their generation you need to edit
\fB/etc/g\-sorcery/gs\-elpa.json\fP file: remove packages you need
from the \fIexclude\fP list in the \fIcommon_config\fP inside this config file.
.TP
.B Generating user ebuilds in user overlay
Create new user overlay. Run
.sp
\fBgs\-elpa \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r gnu\-elpa\fP \fBsync\fP
.sp
List packages:
.sp
\fBgs\-elpa \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r gnu\-elpa\fP \fBlist\fP
.sp
Install any package you want:
.sp
\fBgs\-elpa \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r gnu\-elpa\fP \fBinstall\fP \fIPACKAGE\fP
.sp
Repositories you can use are gnu\-elpa, marmalade, melpa and melpa\-stable. You can use them
all in one overlay. 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\-elpa\fP supports is \fBportage\fP\&.
.UNINDENT
.SH BUGS
.sp
Some packages in \fBmarmalade\fP , \fBmelpa\fP, \fBmelpa\-stable\fP depend on packages from gnu\-elpa. \fBinstall\fP and \fBgenerate\fP
commands will fail on them as dependencies between overlays are not supported currently. So the
recommended way of using gs\-elpa is using it with layman. Even doing so you should always add
gnu\-elpa repository: \fBlayman \-a gnu\-elpa\fP\&.
.SH SEE ALSO
.sp
\fBgs\-pypi\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
.SH AUTHOR
Written by Jauhien Piatlicki <jauhien@gentoo.org>. GSoC idea
and mentorship by Rafael Martins. Lots of help and improvements
by Brian Dolbec.
.SH COPYRIGHT
Copyright (c) 2013-2014 Jauhien Piatlicki, License: GPL-2
.\" Generated by docutils manpage writer.
.