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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/* NSC -- new Scala compiler
* Copyright 2005-2011 LAMP/EPFL
* @author Stephane Micheloud
*/
package scala.man1
object sbaz extends Command {
import _root_.scala.tools.docutil.ManPage._
protected val cn = new Error().getStackTrace()(0).getClassName()
val name = Section("NAME",
MBold(command) & " " & NDash & " Scala package sharing tool for the " &
Link("Scala 2", "http://scala-lang.org/") & " language")
val synopsis = Section("SYNOPSIS",
CmdLine(" [ " & Argument("global_options") & " ] " & Argument("command") &
" [ " & Argument("command_options") & " ]"))
val parameters = Section("PARAMETERS",
DefinitionList(
Definition(
Mono(Argument("global_options")),
"Command line options. See " & Link(Bold("OPTIONS"), "#options") &
" below."),
Definition(
Mono(Argument("command")),
"Internal " & MBold(command) & " command."),
Definition(
Mono(Argument("command_options")),
MBold(command) & " command options.")))
val description = Section("DESCRIPTION",
"The " & MBold(command) & " tool is a system used by Scala enthusiasts " &
"to share computer files with each other. In particular, it makes it " &
"easy to share libraries and applications.")
val options = Section("OPTIONS",
"The " & MBold(command) & " tool has a set of standard options that are " &
"supported on the current development environment and will be supported " &
"in future releases.",
Section("Global Options",
DefinitionList(
Definition(
CmdOption("d", Argument("dir")),
"Operate on dir as the local managed directory."),
Definition(
CmdOption("n") & "| " & CmdOptionLong("dryrun"),
"Do not actually do anything. Only print out what " +
"tool would normally do with the following arguments."),
Definition(
CmdOption("v") & "| " & CmdOptionLong("verbose"),
"Output messages about what the " & MBold(command) & " tool is doing"),
Definition(
CmdOption("version"),
"Display the version information"),
Definition(
CmdOption("-univ") & Argument("name"),
"Operate on the named remote universe, selected from those " &
"in the local managed directory's universe. Affects "&
"the "&MBold("share")&" and "&MBold("retract")&" commands."),
Definition(
CmdOption("-univ-url") & Argument("url"),
"Operate on the universe at the specified URL. Affects "&
"the "&MBold("share")&" and "&MBold("retract")&" commands."))),
Section("Available Commands",
DefinitionList(
Definition(
MBold("available"),
"List the available packages for installation; only display the " +
"three most recent versions of each package."),
Definition(
MBold("available") & " " & CmdOption("a"),
"List the available packages for installation; display all shared " +
"versions of each package."),
Definition(
MBold("compact"),
"Clear the download cache to save space."),
Definition(
MBold("help"),
"Display a help message."),
Definition(
MBold("install"),
"Install a package."),
Definition(
MBold("installed"),
"List the packages that are installed."),
Definition(
MBold("keycreate"),
"Request that a new key be created."),
Definition(
MBold("keyforget"),
"Forget the specified key."),
Definition(
MBold("keyknown"),
"List all known keys."),
Definition(
MBold("keyremember"),
"Remember the specified key for future use."),
Definition(
MBold("keyremoteknown"),
"List all keys known to the bazaar server."),
Definition(
MBold("keyrevoke"),
"Request that a specified key be revoked."),
Definition(
MBold("pack") & " " & Argument("name") & " " & Argument("directory") &
" [ " & Argument("options") & " ]",
"Create an sbaz package and, if a link base is specified, "&
"an advertisement file. The package file is named " &
Mono("name-version.sbp") & ". The advertisement file is named " &
Mono("name-version.advert") & ". The URL is the advertisement " &
"file is the URL base with the package filename appended."),
Definition(
MBold("remove"),
"Remove a package."),
Definition(
MBold("retract"),
"Retract a previously shared package."),
Definition(
MBold("setuniverse"),
"Set the universe for a directory."),
Definition(
MBold("setup"),
"Initialize a directory to be managed."),
Definition(
MBold("share") & " " & Argument("filename"),
"Share a package advertisement on a bazaar."),
Definition(
MBold("share") & " " & CmdOption("i", Argument("descriptor")),
"The package advertisement is usually specified in a file, " &
"but it may also be specified on the command line with the " &
CmdOption("i") & " option."),
Definition(
MBold("share") & " " & CmdOptionLong("template"),
"If " & CmdOptionLong("template") & " is specified, then instead " &
"of uploading a description, the command prints out a template " &
"of a package advertisement."),
Definition(
MBold("show"),
"Show information about one package."),
Definition(
MBold("update"),
"Update the list of available packages."),
Definition(
MBold("upgrade"),
"Upgrade all possible packages."))))
val examples = Section("EXAMPLES",
DefinitionList(
Definition(
"Update the list of available packages.",
CmdLine(MBold("update"))),
Definition(
"Upload package description for " & Mono("scala-devel-2.5.1") &
" to the universe",
CmdLine(MBold("share") & " scala-devel-2.5.1.advert"))))
val exitStatus = Section("EXIT STATUS",
MBold(command) & " returns a zero exist status if it succeeds to process " &
"the specified input files. Non zero is returned in case of failure.")
override val authors = Section("AUTHOR",
"Written by Lex Spoon.")
val seeAlso = Section("SEE ALSO",
Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
date = "August 24, 2006"
author = "Stephane Micheloud"
version = "0.3"
sections = List(
name,
synopsis,
parameters,
description,
options,
examples,
exitStatus,
authors,
bugs,
copyright,
seeAlso)
}
}
|
