diff options
Diffstat (limited to 'src/manual/scala/man1/sbaz.scala')
| -rw-r--r-- | src/manual/scala/man1/sbaz.scala | 209 |
1 files changed, 0 insertions, 209 deletions
diff --git a/src/manual/scala/man1/sbaz.scala b/src/manual/scala/man1/sbaz.scala deleted file mode 100644 index 2e12330408..0000000000 --- a/src/manual/scala/man1/sbaz.scala +++ /dev/null @@ -1,209 +0,0 @@ -/* NSC -- new Scala compiler - * Copyright 2005-2011 LAMP/EPFL - * @author Stephane Micheloud - */ - -package scala.man1 - -/** - * @author Stephane Micheloud - * @version 1.0 - */ -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( - CmdOptionLong("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( - CmdOptionLong("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 2006" - author = "Stephane Micheloud" - version = "0.3" - sections = List( - name, - synopsis, - parameters, - description, - options, - examples, - exitStatus, - authors, - bugs, - copyright, - seeAlso) - } -} |