diff --git a/doc/man/sde-build.txt b/doc/man/sde-build.txt index f015b8f..06c81d1 100644 --- a/doc/man/sde-build.txt +++ b/doc/man/sde-build.txt @@ -4,17 +4,39 @@ The OpenSDE Community NAME ---- +sde-build - Build stuff SYNOPSIS -------- -'sde build' [OPTIONS] +'sde build' [DISCRIMINATOR] [OPTIONS] ITEMS DESCRIPTION ----------- +Builds all or TODO -EXAMPLES --------- +DISCRIMINATORS +-------------- -SEE ALSO --------- +config, cfg:: + Start building the full configuration +package, pkg:: + Allows to add or remove packages to/from the build queue without + actually starting the build +repository, repo:: + Allows to add or remove all packages in a repository to/from the + build queue without actually starting the build + +OPTIONS +------- +--enqueue:: + Adds the given item (packages or all packages in a repository) to + the build queue +--dequeue:: + Removes the given item (packages or all packages in a repository) + from the build queue +--dependees:: + Instead of adding the package, all its dependees will be added to + the build queue. +--stage:: + Only perfom the action (build/enqueue/dequeue) for the given stage. diff --git a/doc/man/sde-cleanup.txt b/doc/man/sde-cleanup.txt index cc302c4..5a9960c 100644 --- a/doc/man/sde-cleanup.txt +++ b/doc/man/sde-cleanup.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde cleanup - cleanup part of the system SYNOPSIS -------- @@ -11,10 +12,9 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- +Cleans up the identified part (item) of the 'sde' indicated by +the discriminator. If no item is specified the whole section +(discriminator) in the 'sde' environment is cleaned up. +Depending on the specified item or discriminator, cleanup indicates +tidying things up or removing it completely diff --git a/doc/man/sde-commit.txt b/doc/man/sde-commit.txt index 340b8a9..b07590d 100644 --- a/doc/man/sde-commit.txt +++ b/doc/man/sde-commit.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde commit - Commit changes SYNOPSIS -------- @@ -11,10 +12,8 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Commits changes to the identified part (item) within the sde environment +section indicated by the discriminator. When the user has commit rights to the +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. diff --git a/doc/man/sde-config.txt b/doc/man/sde-config.txt index 946e74d..2b1a066 100644 --- a/doc/man/sde-config.txt +++ b/doc/man/sde-config.txt @@ -1,10 +1,10 @@ sde-config(1) -================ +============= The OpenSDE Community NAME ---- -sde-config configures part of the system +sde-config - configures part of the system SYNOPSIS -------- @@ -62,10 +62,3 @@ SECTIONS AND KEYS ON GLOBAL SDE CONFIGURATION - 'altdir' - 'curl-opt' - 'mirror' (kept unique per version only) - -EXAMPLES --------- - -SEE ALSO --------- - diff --git a/doc/man/sde-copy.txt b/doc/man/sde-copy.txt index 75be316..bdc6508 100644 --- a/doc/man/sde-copy.txt +++ b/doc/man/sde-copy.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde copy - copy part of the system SYNOPSIS -------- @@ -11,10 +12,5 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Copies the identified part (item) of the sde environment indicated by the +discriminator. diff --git a/doc/man/sde-create.txt b/doc/man/sde-create.txt index 3451758..b3e4dc0 100644 --- a/doc/man/sde-create.txt +++ b/doc/man/sde-create.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde create - enhance the system with new parts SYNOPSIS -------- @@ -11,10 +12,5 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Create a new part with the identified name (item) within the sde environment +section indicated by the discriminator. diff --git a/doc/man/sde-download.txt b/doc/man/sde-download.txt index 7344587..8f2468c 100644 --- a/doc/man/sde-download.txt +++ b/doc/man/sde-download.txt @@ -4,7 +4,7 @@ The OpenSDE Community NAME ---- -sde-download downloads stuff +sde-download - Downloads stuff SYNOPSIS -------- @@ -71,9 +71,3 @@ DESCRIPTION sde-download downloads one or more packages indicated or belonging to the specified name (items). Multiple items can be specified. -EXAMPLES --------- - -SEE ALSO --------- - diff --git a/doc/man/sde-export.txt b/doc/man/sde-export.txt index 180d741..04bb640 100644 --- a/doc/man/sde-export.txt +++ b/doc/man/sde-export.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde export - Export stuff out of the system SYNOPSIS -------- @@ -11,10 +12,10 @@ SYNOPSIS DESCRIPTION ----------- +Exports part of the sde system specified by item. All information belonging to +the specified item will be wrapped up in a single file specified by filename. +This file can be imported again elsewhere. The option is ideal for sending +information to the opensde mailing list. -EXAMPLES --------- - -SEE ALSO --------- - +If the file specified by filename already exists the command will abort unless +the --force option is specified. In this case the file will be overwritten. diff --git a/doc/man/sde-help.txt b/doc/man/sde-help.txt index 067af63..f0a4fad 100644 --- a/doc/man/sde-help.txt +++ b/doc/man/sde-help.txt @@ -4,17 +4,13 @@ The OpenSDE Community NAME ---- +sde-help - provides help about the usage of the 'sde' wrapper SYNOPSIS -------- -'sde help' [OPTIONS] +'sde help' [COMMAND] DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Provides help about the commands available for the 'sde' wrapper +on the current tree. diff --git a/doc/man/sde-import.txt b/doc/man/sde-import.txt index 7453e7c..abbbea9 100644 --- a/doc/man/sde-import.txt +++ b/doc/man/sde-import.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde import - import stuff into the system SYNOPSIS -------- @@ -11,10 +12,8 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Imports the specified filename into the opensde environment under the name +specified by item. If no item name is specified the original, as it was +exported, item name will be used. The content of the specified file need to +match the kind of content specified by the discriminator. In case the content +does not match the command will abort with an error message. diff --git a/doc/man/sde-install.txt b/doc/man/sde-install.txt index eee1020..2a06875 100644 --- a/doc/man/sde-install.txt +++ b/doc/man/sde-install.txt @@ -4,17 +4,13 @@ The OpenSDE Community NAME ---- +sde install - install the wrapper SYNOPSIS -------- -'sde install' [OPTIONS] +'sde install' DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +Install the `sde` wrapper on '$HOME/bin' which is expected to be +on your '$PATH'. diff --git a/doc/man/sde-list.txt b/doc/man/sde-list.txt index ec19cf9..31b2343 100644 --- a/doc/man/sde-list.txt +++ b/doc/man/sde-list.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde list - produce lists needed by other commands SYNOPSIS -------- @@ -51,12 +52,3 @@ OPTIONS FOR DOWNLOAD --location:: include the download location when listing. -DESCRIPTION ------------ - -EXAMPLES --------- - -SEE ALSO --------- - diff --git a/doc/man/sde-update.txt b/doc/man/sde-update.txt index 1ddae59..2612324 100644 --- a/doc/man/sde-update.txt +++ b/doc/man/sde-update.txt @@ -4,6 +4,7 @@ The OpenSDE Community NAME ---- +sde update - updates part of the system with upstream info SYNOPSIS -------- @@ -11,10 +12,4 @@ SYNOPSIS DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +TODO diff --git a/doc/man/sde.txt b/doc/man/sde.txt index 8ebab08..5963dde 100644 --- a/doc/man/sde.txt +++ b/doc/man/sde.txt @@ -4,17 +4,13 @@ The OpenSDE Community NAME ---- +sde - front end wrapper SYNOPSIS -------- -'sde' [OPTIONS] +'sde' [COMMAND] [DISCRIMINATOR] [OPTIONS] DESCRIPTION ----------- - -EXAMPLES --------- - -SEE ALSO --------- - +The `sde` frontend wrapper is supposed to help to use the 'sde' +commands from within multiple 'sde' trees, from '$PATH'