Resyncronized man pages with the updated sources - poor misl doesn't have a working asciidoc/xmlto chain :p

doc/man/sde-build.1

@@ -1,57 +1,108 @@
 .\"     Title: sde-build
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 07/10/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-BUILD" "1" "07/10/2007" "" ""
+.TH "SDE\-BUILD" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-sde\-build \- Build stuff
+sde\-build \- Build or prepare packages for being build.
 .SH "SYNOPSIS"
-\fIsde build\fR [DISCRIMINATOR] [OPTIONS] ITEMS
+\fBsde build\fR [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEMS\fR]
 .sp
 .SH "DESCRIPTION"
-Builds all or TODO
+Builds, enqueues or dequeues specified items.
 .sp
 .SH "DISCRIMINATORS"
 .PP
-config, cfg
+\fBconfig, cfg\fR
 .RS 4
-Start building the full configuration
+Start building the full configuration or queued packages of the config identified by item. If no item specified the config will use
+\fIdefault\fR.
 .RE
 .PP
-package, pkg
+\fBpackage, pkg\fR
 .RS 4
-Allows to add or remove packages to/from the build queue without actually starting the build
+Builds single packages, but also allows adding or removing packages to/from the build queue without actually starting the build.
 .RE
 .PP
-repository, repo
+\fBrepository, repo\fR
 .RS 4
-Allows to add or remove all packages in a repository to/from the build queue without actually starting the build
+Builds all packages in a repository, but also allows adding or removing all packages in a repository to/from the build queue without actually starting the build
 .RE
-.SH "OPTIONS"
+.SH "OPTIONS FOR CONFIG DISCRIMINATOR"
 .PP
-\-\-enqueue
+\fB\-\-queued\fR
 .RS 4
-Adds the given item (packages or all packages in a repository) to the build queue
+Only build queued packages.
 .RE
 .PP
-\-\-dequeue
+\fB\-\-stage name\fR
 .RS 4
-Removes the given item (packages or all packages in a repository) from the build queue
+Only build the given stage if possible. The stage will only build if previous stages have been build in the past.
 .RE
+.SH "OPTIONS FOR PACKAGE DISCRIMINATOR"
 .PP
-\-\-dependees
+\fB\-c, \-\-cfg, \-\-config name\fR
 .RS 4
-Instead of adding the package, all its dependees will be added to the build queue.
+Use the given config to perform the specified action.
 .RE
 .PP
-\-\-stage
+\fB\-\-enqueue\fR
 .RS 4
-Only perfom the action (build/enqueue/dequeue) for the given stage.
+Adds the given items (packages) to the build queue.
 .RE
+.PP
+\fB\-\-dequeue\fR
+.RS 4
+Removes the given items (packages) from the build queue
+.RE
+.PP
+\fB\-\-dependent\fR
+.RS 4
+Besides adding packages, all packages depending on one of these packages will also be added or removed to/from the build queue.
+.RE
+.PP
+\fB\-\-stage name\fR
+.RS 4
+Only perfom the action (build/enqueue/dequeue) for the given stage. Without this option packages will be queued for all valid stages. What stages are valid can be found in package
+\fB.desc\fR
+files.
+.RE
+.SH "OPTIONS FOR REPOSITORY DISCRIMINATOR"
+.PP
+\fB\-c, \-\-cfg, \-\-config name\fR
+.RS 4
+Use the given config to perform the specified action.
+.RE
+.PP
+\fB\-\-enqueue\fR
+.RS 4
+Adds the given items (all packages in the specified repositories) to the build queue
+.RE
+.PP
+\fB\-\-dequeue\fR
+.RS 4
+Removes the given items (all packages in the specified repositories) from the build queue
+.RE
+.PP
+\fB\-\-stage name\fR
+.RS 4
+Only perfom the action (build/enqueue/dequeue) for the given stage. Without this option packages will be queued for all valid stages. What stages are valid can be found in package
+\fB.desc\fR
+files.
+.RE
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.sp

doc/man/sde-clean.1

@@ -0,0 +1,90 @@
+.\"     Title: sde-clean
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
+.\"      Date: 11/25/2007
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "SDE\-CLEAN" "1" "11/25/2007" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+sde\-clean \- Cleans up part of the system
+.SH "SYNOPSIS"
+\fBsde cleanup\fR [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEMS\fR]
+.sp
+.SH "DESCRIPTION"
+Cleans up the identified part (item) of your \fBsde\fR environment indicated by the discriminator. If no item is specified the whole section (discriminator) in your \fBsde\fR environment will be cleaned. Depending on the specified item or discriminator, cleanup indicates tidying things up or removing it completely
+.sp
+.SH "DISCRIMINATORS"
+.PP
+\fBbuild\fR
+.RS 4
+Removes actual builds specified by their actual location or the config name used to create it.
+.RE
+.PP
+\fBcache\fR
+.RS 4
+Removes ccache files for the specified architectures (items). If no architectures specified, ccache files for all architectrues will be removed.
+.RE
+.PP
+\fBconfig, cfg\fR
+.RS 4
+Removed specified configurations (items).
+.RE
+.PP
+\fBdownload\fR
+.RS 4
+Removes old downloads from your old local download mirror. Only downloads still specified in .desc files will not be removed.
+.RE
+.PP
+\fBpackage, pkg\fR
+.RS 4
+Brings all specified packages (items) back to their original state. All uncommitted changes will be lost.
+.RE
+.PP
+\fBrepository, repo\fR
+.RS 4
+Brings the specified repositories (items) back to their original state. All uncommitted changes will be lost.
+.RE
+.PP
+\fBsystem, sys\fR
+.RS 4
+Brings your
+\fIsde\fR
+environment back to its original state. All uncommitted changes will be lost.
+.RE
+.PP
+\fBtarget, tgt\fR
+.RS 4
+Brings all specified targets (items) back to their original state. All uncommitted changes will be lost.
+.RE
+.SH "OPTIONS FOR ALL DISCRIMINATORS"
+.PP
+\fB\-\-dry\-run\fR
+.RS 4
+Processes normally, but does not clean or modify anything.
+.RE
+.PP
+\fB\-f, \-\-force\fR
+.RS 4
+Prevents user interaction. Cleaning will continue without explicit acknowlegdement from the user.
+.RE
+.PP
+\fB\-q, \-\-quiet\fR
+.RS 4
+Reduces feedback to an absolute minimum. \-v, \-\-verbose: Gives additional feedback.
+.RE
+The options \fIverbose\fR and \fIquiet\fR are mutually exclusive.
+.sp
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.sp

doc/man/sde-commit.1

@@ -1,11 +1,11 @@
 .\"     Title: sde-commit
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 08/10/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-COMMIT" "1" "08/10/2007" "" ""
+.TH "SDE\-COMMIT" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -13,47 +13,47 @@
 .SH "NAME"
 sde\-commit \- Commit changes
 .SH "SYNOPSIS"
-\fIsde commit\fR [DISCRIMINATORS] [OPTIONS] [ITEMS\]
+\fBsde commit\fR [\fICMMAND\fR] [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEMS\fR]
 .sp
 .SH "DESCRIPTION"
 Commits changes to the identified part (item) within the sde environment section indicated by the discriminator. When the user has commit rights to the SCM repository containing the item, using this command will indeed commit the changes. If there are no commit rights to the repository, all changes will be wrapped up in a patch and send to the mailing list.
 .sp
 .SH "DISCRIMINATORS"
 .PP
-package, pkg
+\fBpackage, pkg\fR
 .RS 4
-Commits changes to the specified package(s).
+Commits changes to the specified packages (items).
 .RE
 .PP
-repository, repo
+\fBrepository, repo\fR
 .RS 4
-Commits all modified pkgs in the specified repository.
+Commits all modified pkgs in the specified repositories (items).
 .RE
 .PP
-system, sys
+\fBsystem, sys\fR
 .RS 4
 Commits all changes to the sde framework itself. For this discriminator no items should be provided.
 .RE
 .PP
-target, tgt
+\fBtarget, tgt\fR
 .RS 4
-Commits changes to the specified target(s).
+Commits all changes to the specified targets (items).
 .RE
-When no discriminator is specified, package will be used as the default discriminator.
+When no discriminator is specified, this command will default to the closest discriminator in regard to the current working directory.
 .sp
 .SH "OPTIONS"
 .PP
-\-\-dry\-run, \-d
+\fB\-\-dry\-run, \-d\fR
 .RS 4
 Gives feedback of what would be done, but does not really commit.
 .RE
 .PP
-\-\-message, \-m
+\fB\-\-message, \-m\fR
 .RS 4
 Allows to specify the commit message on the command line. The argument specifies the actual commit message.
 .RE
 .PP
-\-\-file, \-f
+\fB\-\-file, \-f\fR
 .RS 4
 Allows long commit message to be read frome file. The argument specifies the file from which to read the message.
 .RE
@@ -64,3 +64,12 @@ Allows long commit message to be read frome file. The argument specifies the fil
 sde ci .
 .fi
 .RE
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.sp

doc/man/sde-config.1

@@ -1,11 +1,11 @@
 .\"     Title: sde-config
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 07/12/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-CONFIG" "1" "07/12/2007" "" ""
+.TH "SDE\-CONFIG" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -13,87 +13,78 @@
 .SH "NAME"
 sde\-config \- configures part of the system
 .SH "SYNOPSIS"
-\fIsde config\fR [DISCRIMINATOR] [OPTIONS]
+\fBsde\-config\fR [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEM\fR]
+.sp
+.SH "DESCRIPTION"
+sde\-config configures part of your sde environment specified by the given discriminator.
 .sp
 .SH "DISCRIMINATORS"
 .PP
-config, cfg
+\fBconfig, cfg\fR
 .RS 4
-TODO (this is the default if none is given)
+Configures the config identified by ITEM. If no item specified the config will be named
+\fIdefault\fR.
 .RE
 .PP
-system, sys
+\fBsystem, sys\fR
 .RS 4
-Allows to query or modify global sde configuration parameters.
+Makes it possible to query or modify global sde configuration parameters. For this discriminator no item should be specified.
 .RE
-.SH "OPTIONS FOR \fICONFIG\fR DISCRIMINATOR"
+When no discriminator is detected, this command will default to the \fBconfig\fR discriminator.
+.sp
+.SH "OPTIONS FOR CONFIG DISCRIMINATOR"
 .PP
-\-n, \-\-non\-interactive
+\fB\-n, \-\-non\-interactive\fR
 .RS 4
 Reconfigures an existing config without the interactive configuration application.
 .RE
 .PP
-\-c, \-\-cfg name
-.RS 4
-Defines the name to be used for a given
-\fIconfig\fR, the name
-\fIdefault\fR
-is used if this option is not supplied.
-.RE
-.PP
-\-\-nobashmod
+\fB\-\-nobashmod\fR
 .RS 4
 Don't use the bash config helper plugin
 .RE
 .PP
-\-\-profile
+\fB\-\-profile\fR
 .RS 4
 Create a config.profile with profiling data
 .RE
 .PP
-\-q, \-\-quiet
-.RS 4
-Feedback will be reduced to an absolute minimum.
-.RE
-.PP
-\-v, \-\-verbose
+\fB\-q, \-\-quiet\fR
 .RS 4
-Feedback will be augmented with additional information.
+Reduces feedback to an absolute minimum. \-v, \-\-verbose: Gives additional feedback.
 .RE
-.SH "OPTIONS FOR \fISYSTEM\fR DISCRIMINATOR"
+.SH "OPTIONS FOR SYSTEM DISCRIMINATOR"
 .PP
-\-g, \-\-get key
+\fB\-g, \-\-get key\fR
 .RS 4
 returns the value of a specified
 \fIsection.key\fR
 .RE
 .PP
-\-s, \-\-set key=value
+\fB\-s, \-\-set key=value\fR
 .RS 4
 sets the value of a specified
 \fIsection.key\fR
 .RE
 .PP
-\-\-dump
+\fB\-\-dump\fR
 .RS 4
 dumps the relevant content of the
 \fIsettings\fR
 file for the current sde instance.
 .RE
 .PP
-\-\-path
+\fB\-\-path\fR
 .RS 4
 outputs the full path to the
 \fIsettings\fR
 file in use.
 .RE
-.SH "DESCRIPTION"
-sde\-config configures the identified part (item) within the sde environment section indicated by the discriminator.
-.sp
 .SH "SECTIONS AND KEYS ON GLOBAL SDE CONFIGURATION"
 .RS 4
 \h'-04'\(bu\h'+03'
 \fIdownload\fR
+.RE
 .RS 4
 \h'-04'\(bu\h'+03'
 \fIaltdir\fR
@@ -107,4 +98,12 @@ sde\-config configures the identified part (item) within the sde environment sec
 \fImirror\fR
 (kept unique per version only)
 .RE
-.RE
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.sp

doc/man/sde-copy.1

@@ -1,20 +1,63 @@
 .\"     Title: sde-copy
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 07/10/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-COPY" "1" "07/10/2007" "" ""
+.TH "SDE\-COPY" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-sde\-copy \- copy part of the system
+sde\-copy \- copies part of the system
 .SH "SYNOPSIS"
-\fIsde copy\fR [OPTIONS]
+\fBsde\-copy\fR [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEM\fR] [\fIITEMNEW\fR]
 .sp
 .SH "DESCRIPTION"
-Copies the identified part (item) of the sde environment indicated by the discriminator.
+Copies part of the system to a new name. The discriminator indicates in what section of the sde system the copy will take place. The item indicates what part will be copied to the new item name.
+.sp
+.SH "DISCRIMINATORS"
+.PP
+\fBbuild\fR
+.RS 4
+Copies an existing build to a new one. The item specifies the config name that was used for the build. The new item name specifies the new config name. With this discriminator both the build and the accompanying config will be copied.
+.RE
+.PP
+\fBconfig, cfg\fR
+.RS 4
+Copies an existing config identified by item to a new one. When no item name is specified,
+\fIdefault\fR
+will be used.
+.RE
+.PP
+\fBpackage, pkg\fR
+.RS 4
+Copies an existing package (item) to a new one. For this discriminator full qualified package names are required. Fully qualified package names are names in which the actual package name is preceded by the repository name separated by a dot (.).
+.RE
+.PP
+\fBtarget, tgt\fR
+.RS 4
+Copies an existing target identified by item to a new one.
+.RE
+.SH "OPTIONS FOR ALL DISCRIMINATORS"
+.PP
+\fB\-f, \-\-force\fR
+.RS 4
+Allows to overwrite existing items in case the specified new item already exists.
+.RE
+.PP
+\fB\-q, \-\-quiet\fR
+.RS 4
+Reduces feedback to an absolute minimum. \-v, \-\-verbose: Gives additional feedback.
+.RE
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .sp

doc/man/sde-create.1

@@ -1,20 +1,67 @@
 .\"     Title: sde-create
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 07/10/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-CREATE" "1" "07/10/2007" "" ""
+.TH "SDE\-CREATE" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-sde\-create \- enhance the system with new parts
+sde\-create \- enhance your sde system with new parts
 .SH "SYNOPSIS"
-\fIsde create\fR [OPTIONS]
+\fBsde\-create\fR [\fIDISCRIMINATOR\fR] [\fIOPTIONS\fR] [\fIITEM\fR]
 .sp
 .SH "DESCRIPTION"
 Create a new part with the identified name (item) within the sde environment section indicated by the discriminator.
 .sp
+.SH "DISCRIMINATORS"
+.PP
+\fBconfig, cfg\fR
+.RS 4
+Creates a new default configured config with the given name (item).
+.RE
+.PP
+\fBpackage, pkg\fR
+.RS 4
+Creates a new package. The given item is expected to be the fully qualified package name. This is the package name preceded by the repository it should be placed in, separated by a dot.
+.RE
+.PP
+\fBtarget, tgt\fR
+.RS 4
+Creates a new target with the given name (item).
+.RE
+.SH "OPTIONS FOR ALL DISCRIMINATORS"
+.PP
+\fB\-q, \-\-quiet\fR
+.RS 4
+Reduces feedback to an absolute minimum.
+.RE
+.PP
+\fB\-v, \-\-verbose\fR
+.RS 4
+Gives additional feedback.
+.RE
+.SH "OPTIONS FOR PACKAGE DISCRIMINATOR"
+.PP
+\fB\-\-hive hive.index\fR
+.RS 4
+Makes it Possible to create new packages from available package hives like freshmeat or sourceforge. With this flag you need to specify which hive to use and what the ID of the package in that hive is.
+.RE
+.PP
+\fB\-\-hivelist\fR
+.RS 4
+Does not create a package but shows a list of all available hives.
+.RE
+.SH "AUTHOR"
+Written by Minto van der Sluis (misl).
+.sp
+.SH "REPORTING BUGS"
+Report bugs to <list@opensde.org>.
+.sp
+.SH "COPYRIGHT"
+Copyright \(co 2007 The OpenSDE project. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.sp

doc/man/sde-download.1

@@ -1,19 +1,19 @@
 .\"     Title: sde-download
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 07/28/2007
+.\"      Date: 11/25/2007
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "SDE\-DOWNLOAD" "1" "07/28/2007" "" ""
+.TH "SDE\-DOWNLOAD" "1" "11/25/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-sde\-download \- Downloads stuff
+sde\-download \- Downloads packages
 .SH "SYNOPSIS"
-\fIsde download\fR [DISCRIMINATOR] [OPTIONS] [ITEMS\]
+\fIsde download\fR [DISCRIMINATOR] [OPTIONS] [ITEMS]
 .sp
 .SH "DESCRIPTION"
 sde\-download downloads one or more packages indicated or belonging to the specified name (items). Multiple items can be specified.
@@ -22,12 +22,12 @@ sde\-download downloads one or more packages indicated or belonging to the speci
 .PP
 config, cfg
 .RS 4
-Downloads all packages in the config specified by item.
+Downloads all selected packages in the specified config (item).
 .RE
 .PP
 package, pkg
 .RS 4
-Downloads the packages specified by item. (this is the default if none is given)
+Downloads single packages specified by item.
 .RE
 .PP
 repository, repo
@@ -38,12 +38,7 @@ Downloads all packages in the repositories specified by item.
 .PP
 \-q, \-\-quiet
 .RS 4
-Gives minimal feedback.
-.RE
-.PP
-\-v, \-\-verbose
-.RS 4
-Gives extra feedback.
+Reduces feedback to an absolute minimum. \-v, \-\-verbose: Gives additional feedback.
 .RE
 .PP
 \-n, \-\-dry\-run
@@ -51,15 +46,6 @@ Gives extra feedback.
 No real download is performed but the list of missing files is output.
 .RE
 .PP
-\-c, \-\-cfg
-.RS 4
-Specify a config to restrict
-\fIpackage\fR
-and
-\fIrepository\fR
-discriminators.
-.RE
-.PP
 \-\-timeout
 .RS 4
 Defines how tolerat to download delay are we. The default value is