diff options
author | michelou <michelou@epfl.ch> | 2006-06-08 09:17:57 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2006-06-08 09:17:57 +0000 |
commit | ddbd7463f2d2d8393b6d131d5dc13cb4b90b98f1 (patch) | |
tree | 457928063c6140d6b825a20dc953fb8d35906dc2 /docs/man | |
parent | 52f4d886518e4cd45438d8341b018b3397606732 (diff) | |
download | scala-ddbd7463f2d2d8393b6d131d5dc13cb4b90b98f1.tar.gz scala-ddbd7463f2d2d8393b6d131d5dc13cb4b90b98f1.tar.bz2 scala-ddbd7463f2d2d8393b6d131d5dc13cb4b90b98f1.zip |
added man page for sbaz
Diffstat (limited to 'docs/man')
-rw-r--r-- | docs/man/build.xml | 2 | ||||
-rw-r--r-- | docs/man/src/man/EmitHtml.scala | 2 | ||||
-rw-r--r-- | docs/man/src/man/EmitManPage.scala | 2 | ||||
-rw-r--r-- | docs/man/src/man/ManPage.scala | 2 | ||||
-rw-r--r-- | docs/man/src/man/man1/Command.scala | 2 | ||||
-rw-r--r-- | docs/man/src/man/man1/sbaz.scala | 173 | ||||
-rw-r--r-- | docs/man/src/man/man1/scala.scala | 7 | ||||
-rw-r--r-- | docs/man/src/man/man1/scalac.scala | 7 | ||||
-rw-r--r-- | docs/man/src/man/man1/scaladoc.scala | 7 | ||||
-rw-r--r-- | docs/man/src/man/man1/scalaint.scala | 7 | ||||
-rw-r--r-- | docs/man/src/man/man1/scalap.scala | 17 | ||||
-rw-r--r-- | docs/man/src/man/man1/scalascript.scala | 7 |
12 files changed, 208 insertions, 27 deletions
diff --git a/docs/man/build.xml b/docs/man/build.xml index 1b00542a64..37116463ff 100644 --- a/docs/man/build.xml +++ b/docs/man/build.xml @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- $Id$ --> <project name="scala-manpages" default="build"> @@ -47,6 +48,7 @@ <target name="dist" depends="build"> <mkdir dir="${dist.dir}"/> + <emit command="sbaz"/> <emit command="scala"/> <emit command="scalac"/> <emit command="scaladoc"/> diff --git a/docs/man/src/man/EmitHtml.scala b/docs/man/src/man/EmitHtml.scala index 6ad366bd4a..e6d773c185 100644 --- a/docs/man/src/man/EmitHtml.scala +++ b/docs/man/src/man/EmitHtml.scala @@ -3,7 +3,7 @@ * @author Stephane Micheloud * Adapted from Lex Spoon's sbaz manual */ -//$Id: $ +//$Id$ package man diff --git a/docs/man/src/man/EmitManPage.scala b/docs/man/src/man/EmitManPage.scala index 363cf1d02a..4ca865fae0 100644 --- a/docs/man/src/man/EmitManPage.scala +++ b/docs/man/src/man/EmitManPage.scala @@ -3,7 +3,7 @@ * @author Stephane Micheloud * Adapted from Lex Spoon's sbaz manual */ -//$Id: $ +//$Id$ package man diff --git a/docs/man/src/man/ManPage.scala b/docs/man/src/man/ManPage.scala index 38d26c7938..aef665bf3f 100644 --- a/docs/man/src/man/ManPage.scala +++ b/docs/man/src/man/ManPage.scala @@ -3,7 +3,7 @@ * @author Stephane Micheloud * Adapted from Lex Spoon's sbaz manual */ -//$Id: $ +//$Id$ package man diff --git a/docs/man/src/man/man1/Command.scala b/docs/man/src/man/man1/Command.scala index bfb6944e72..0fdb9c02e9 100644 --- a/docs/man/src/man/man1/Command.scala +++ b/docs/man/src/man/man1/Command.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 diff --git a/docs/man/src/man/man1/sbaz.scala b/docs/man/src/man/man1/sbaz.scala new file mode 100644 index 0000000000..96caedca61 --- /dev/null +++ b/docs/man/src/man/man1/sbaz.scala @@ -0,0 +1,173 @@ +/* NSC -- new Scala compiler + * Copyright 2005-2006 LAMP/EPFL + * @author Stephane Micheloud + */ +//$Id$ + +package man.man1 + +object sbaz extends Command { + import 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.epfl.ch/") & " 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 ...") + + 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"), + "Do not actually do anything. Only print out what " + + "tool would normally do with the following arguments."))), + + Section("Available Commands", + DefinitionList( + Definition( + MBold("available"), + "List the available packages for installation."), + 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("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") & " 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") & " " & CmdOption("-template"), + "If " & CmdOption("-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.1.5") & + " to the universe", + CmdLine(MBold("share") & " scala-devel-2.1.5.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("scala(1)", "scala.html") & ", " & + Link("scalac(1)", "scalac.html") & ", " & + Link("scaladoc(1)", "scaladoc.html") & ", " & + Link("scalaint(1)", "scalaint.html") & ", " & + Link("scalascript(1)", "scalascript.html")) + + def manpage = new Document { + title = command + date = "April 29, 2005" + author = "Stephane Micheloud" + version = "0.1" + sections = List( + name, + synopsis, + parameters, + description, + options, + examples, + exitStatus, + authors, + bugs, + copyright, + seeAlso) + } +} diff --git a/docs/man/src/man/man1/scala.scala b/docs/man/src/man/man1/scala.scala index 281a1d0585..0ed763fb59 100644 --- a/docs/man/src/man/man1/scala.scala +++ b/docs/man/src/man/man1/scala.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -118,6 +118,7 @@ object scala extends Command { val seeAlso = Section("SEE ALSO", + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & Link(Bold("scalac") & "(1)", "scalac.html") & ", " & Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " & Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " & @@ -126,9 +127,9 @@ object scala extends Command { def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, diff --git a/docs/man/src/man/man1/scalac.scala b/docs/man/src/man/man1/scalac.scala index 35d9f04e2a..5e22d4929d 100644 --- a/docs/man/src/man/man1/scalac.scala +++ b/docs/man/src/man/man1/scalac.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -287,6 +287,7 @@ object scalac extends Command { val seeAlso = Section("SEE ALSO", + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & Link(Bold("scala") & "(1)", "scala.html") & ", " & Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " & Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " & @@ -295,9 +296,9 @@ object scalac extends Command { def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, diff --git a/docs/man/src/man/man1/scaladoc.scala b/docs/man/src/man/man1/scaladoc.scala index e512f3bdfd..da333a88c4 100644 --- a/docs/man/src/man/man1/scaladoc.scala +++ b/docs/man/src/man/man1/scaladoc.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -82,6 +82,7 @@ object scaladoc extends Command { val seeAlso = Section("SEE ALSO", + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & Link(Bold("scala") & "(1)", "scala.html") & ", " & Link(Bold("scalac") & "(1)", "scalac.html") & ", " & Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " & @@ -90,9 +91,9 @@ object scaladoc extends Command { def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, diff --git a/docs/man/src/man/man1/scalaint.scala b/docs/man/src/man/man1/scalaint.scala index 8d881934af..bc3e18866f 100644 --- a/docs/man/src/man/man1/scalaint.scala +++ b/docs/man/src/man/man1/scalaint.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -54,6 +54,7 @@ object scalaint extends Command { val seeAlso = Section("SEE ALSO", + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & Link(Bold("scala") & "(1)", "scala.html") & ", " & Link(Bold("scalac") & "(1)", "scalac.html") & ", " & Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " & @@ -62,9 +63,9 @@ object scalaint extends Command { def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, diff --git a/docs/man/src/man/man1/scalap.scala b/docs/man/src/man/man1/scalap.scala index 6da06eb058..d5396747f7 100644 --- a/docs/man/src/man/man1/scalap.scala +++ b/docs/man/src/man/man1/scalap.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -82,17 +82,18 @@ object scalap extends Command { val seeAlso = Section("SEE ALSO", - Link("scala(1)", "scala.html") & ", " & - Link("scalac(1)", "scalac.html") & ", " & - Link("scaladoc(1)", "scaladoc.html") & ", " & - Link("scalaint(1)", "scalaint.html") & ", " & - Link("scalascript(1)", "scalascript.html")) + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & + Link(Bold("scala") & "(1)", "scala.html") & ", " & + Link(Bold("scalac") & "(1)", "scalac.html") & ", " & + Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " & + Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " & + Link(Bold("scalascript") & "(1)", "scalascript.html")) def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, diff --git a/docs/man/src/man/man1/scalascript.scala b/docs/man/src/man/man1/scalascript.scala index 1ab8b1994f..9768d5654a 100644 --- a/docs/man/src/man/man1/scalascript.scala +++ b/docs/man/src/man/man1/scalascript.scala @@ -2,7 +2,7 @@ * Copyright 2005-2006 LAMP/EPFL * @author Stephane Micheloud */ -//$Id: $ +//$Id$ package man.man1 @@ -76,6 +76,7 @@ object scalascript extends Command { val seeAlso = Section("SEE ALSO", + Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " & Link(Bold("scala") & "(1)", "scala.html") & ", " & Link(Bold("scalac") & "(1)", "scalac.html") & ", " & Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " & @@ -84,9 +85,9 @@ object scalascript extends Command { def manpage = new Document { title = command - date = "April 29, 2005" + date = "June 8, 2006" author = "Stephane Micheloud" - version = "0.1" + version = "0.2" sections = List( name, synopsis, |