From 46f76a690dd2d0cc2b6ee76bf8195f7e53eef44d Mon Sep 17 00:00:00 2001 From: Alejandro Mery Date: Tue, 10 Jul 2007 19:21:02 +0000 Subject: [PATCH] * added generated manpages to doc/man/*.1 git-svn-id: svn://svn.opensde.net/opensde/opensde/trunk@21622 10447126-35f2-4685-b0cf-6dd780d3921f --- doc/man/sde-build.1 | 57 ++++++++++++++++++++++ doc/man/sde-cleanup.1 | 20 ++++++++ doc/man/sde-commit.1 | 20 ++++++++ doc/man/sde-config.1 | 100 +++++++++++++++++++++++++++++++++++++++ doc/man/sde-copy.1 | 20 ++++++++ doc/man/sde-create.1 | 20 ++++++++ doc/man/sde-download.1 | 104 +++++++++++++++++++++++++++++++++++++++++ doc/man/sde-export.1 | 22 +++++++++ doc/man/sde-help.1 | 20 ++++++++ doc/man/sde-import.1 | 20 ++++++++ doc/man/sde-install.1 | 20 ++++++++ doc/man/sde-list.1 | 70 +++++++++++++++++++++++++++ doc/man/sde-update.1 | 20 ++++++++ doc/man/sde.1 | 20 ++++++++ 14 files changed, 533 insertions(+) create mode 100644 doc/man/sde-build.1 create mode 100644 doc/man/sde-cleanup.1 create mode 100644 doc/man/sde-commit.1 create mode 100644 doc/man/sde-config.1 create mode 100644 doc/man/sde-copy.1 create mode 100644 doc/man/sde-create.1 create mode 100644 doc/man/sde-download.1 create mode 100644 doc/man/sde-export.1 create mode 100644 doc/man/sde-help.1 create mode 100644 doc/man/sde-import.1 create mode 100644 doc/man/sde-install.1 create mode 100644 doc/man/sde-list.1 create mode 100644 doc/man/sde-update.1 create mode 100644 doc/man/sde.1 diff --git a/doc/man/sde-build.1 b/doc/man/sde-build.1 new file mode 100644 index 0000000..6bf157f --- /dev/null +++ b/doc/man/sde-build.1 @@ -0,0 +1,57 @@ +.\" Title: sde-build +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-BUILD" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-build \- Build stuff +.SH "SYNOPSIS" +\fIsde build\fR [DISCRIMINATOR] [OPTIONS] ITEMS +.sp +.SH "DESCRIPTION" +Builds all or TODO +.sp +.SH "DISCRIMINATORS" +.PP +config, cfg +.RS 4 +Start building the full configuration +.RE +.PP +package, pkg +.RS 4 +Allows to add or remove packages to/from the build queue without actually starting the build +.RE +.PP +repository, repo +.RS 4 +Allows to add or remove all packages in a repository to/from the build queue without actually starting the build +.RE +.SH "OPTIONS" +.PP +\-\-enqueue +.RS 4 +Adds the given item (packages or all packages in a repository) to the build queue +.RE +.PP +\-\-dequeue +.RS 4 +Removes the given item (packages or all packages in a repository) from the build queue +.RE +.PP +\-\-dependees +.RS 4 +Instead of adding the package, all its dependees will be added to the build queue. +.RE +.PP +\-\-stage +.RS 4 +Only perfom the action (build/enqueue/dequeue) for the given stage. +.RE diff --git a/doc/man/sde-cleanup.1 b/doc/man/sde-cleanup.1 new file mode 100644 index 0000000..c350d39 --- /dev/null +++ b/doc/man/sde-cleanup.1 @@ -0,0 +1,20 @@ +.\" Title: sde-cleanup +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-CLEANUP" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-cleanup \- cleanup part of the system +.SH "SYNOPSIS" +\fIsde cleanup\fR [OPTIONS] +.sp +.SH "DESCRIPTION" +Cleans up the identified part (item) of the \fIsde\fR indicated by the discriminator. If no item is specified the whole section (discriminator) in the \fIsde\fR environment is cleaned up. Depending on the specified item or discriminator, cleanup indicates tidying things up or removing it completely +.sp diff --git a/doc/man/sde-commit.1 b/doc/man/sde-commit.1 new file mode 100644 index 0000000..abd90b8 --- /dev/null +++ b/doc/man/sde-commit.1 @@ -0,0 +1,20 @@ +.\" Title: sde-commit +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-COMMIT" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-commit \- Commit changes +.SH "SYNOPSIS" +\fIsde commit\fR [OPTIONS] +.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 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 diff --git a/doc/man/sde-config.1 b/doc/man/sde-config.1 new file mode 100644 index 0000000..c64cc77 --- /dev/null +++ b/doc/man/sde-config.1 @@ -0,0 +1,100 @@ +.\" Title: sde-config +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-CONFIG" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-config \- configures part of the system +.SH "SYNOPSIS" +\fIsde config\fR [DISCRIMINATOR] [OPTIONS] +.sp +.SH "DISCRIMINATORS" +.PP +config, cfg +.RS 4 +TODO (this is the default if none is given) +.RE +.PP +system, sys +.RS 4 +Allows to change global sde configuration +.RE +.SH "OPTIONS FOR \fICONFIG\fR DISCRIMINATOR" +.PP +\-q, \-\-oldconfig +.RS 4 +Reconfigure an already existant config without interativity with the user. +.RE +.PP +\-c, \-\-cfg +.RS 4 +Defines the id to use for a given +\fIconfig\fR, the name +\fIdefault\fR +is used if this option is not given. +.RE +.PP +\-\-nobashmod +.RS 4 +Don't use the bash config helper plugin +.RE +.PP +\-\-profile +.RS 4 +Create a config.profile with profiling data +.RE +.SH "OPTIONS FOR \fISYSTEM\fR DISCRIMINATOR" +.PP +\-g, \-\-get +.RS 4 +returns the value of a specified +\fIsection.key\fR +.RE +.PP +\-s, \-\-set +.RS 4 +sets the value of a specified +\fIsection.key\fR +.RE +.PP +\-\-dump +.RS 4 +dumps the content of the +\fIsettings\fR +file. +.RE +.PP +\-\-name +.RS 4 +dumps 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 +.RS 4 +\h'-04'\(bu\h'+03' +\fIaltdir\fR +.RE +.RS 4 +\h'-04'\(bu\h'+03' +\fIcurl\-opt\fR +.RE +.RS 4 +\h'-04'\(bu\h'+03' +\fImirror\fR +(kept unique per version only) +.RE +.RE diff --git a/doc/man/sde-copy.1 b/doc/man/sde-copy.1 new file mode 100644 index 0000000..3132359 --- /dev/null +++ b/doc/man/sde-copy.1 @@ -0,0 +1,20 @@ +.\" Title: sde-copy +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-COPY" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-copy \- copy part of the system +.SH "SYNOPSIS" +\fIsde copy\fR [OPTIONS] +.sp +.SH "DESCRIPTION" +Copies the identified part (item) of the sde environment indicated by the discriminator. +.sp diff --git a/doc/man/sde-create.1 b/doc/man/sde-create.1 new file mode 100644 index 0000000..f4cd0eb --- /dev/null +++ b/doc/man/sde-create.1 @@ -0,0 +1,20 @@ +.\" Title: sde-create +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-CREATE" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-create \- enhance the system with new parts +.SH "SYNOPSIS" +\fIsde create\fR [OPTIONS] +.sp +.SH "DESCRIPTION" +Create a new part with the identified name (item) within the sde environment section indicated by the discriminator. +.sp diff --git a/doc/man/sde-download.1 b/doc/man/sde-download.1 new file mode 100644 index 0000000..021f0ad --- /dev/null +++ b/doc/man/sde-download.1 @@ -0,0 +1,104 @@ +.\" Title: sde-download +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-DOWNLOAD" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-download \- Downloads stuff +.SH "SYNOPSIS" +\fIsde download\fR [DISCRIMINATOR] [OPTIONS] [ITEMS\] +.sp +.SH "DISCRIMINATORS" +.PP +config, cfg +.RS 4 +Downloads all packages in the config specified by item. +.RE +.PP +package, pkg +.RS 4 +Downloads the packages specified by item. (this is the default if none is given) +.RE +.PP +repository, repo +.RS 4 +Downloads all packages in the repositories specified by item. +.RE +.SH "OPTIONS" +.PP +\-q, \-\-quiet +.RS 4 +Gives minimal feedback. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Gives extra feedback. +.RE +.PP +\-a, \-\-all +.RS 4 +Downloads every package independently of the specified items. +.RE +.PP +\-d, \-\-dry\-run +.RS 4 +No real download is performed but the list of missing files is output. +.RE +.PP +\-\-timeout +.RS 4 +Defines how tolerat to download delay are we. The default value is +\fInormal\fR, but you can choose between +\fIno\fR +and +\fIlong\fR +too. +.RE +.PP +\-\-check +.RS 4 +Defines when will the tool validate the downloaded file against the checksum in the database. The defailt value is +\fIalways\fR, but you can choose between +\fIdownload\fR, meaning that it wont validate when using the alternative download location, or +\fInever\fR. +.RE +.PP +\-\-mirror +.RS 4 +Defines which mirror to use since now, replacing the value stored on the global config. Alternatively you can use +\fI'none\fR', or auto to detect again the best mirror for your location. +.RE +.PP +\-\-dependencies +.RS 4 +When using +\fIpackage\fR +or +\fIrepository\fR +discriminators, download the active dependencies considering the specified config id. +.RE +.PP +\-c, \-\-copy +.RS 4 +When the file is found on the alternative location the tool will +\fIcopy\fR +it instead of doing a hardlink. +.RE +.PP +\-m, \-\-move +.RS 4 +When the file is found on the alternative location the tool will +\fImove\fR +it instead of doing a hardlink. +.RE +.SH "DESCRIPTION" +sde\-download downloads one or more packages indicated or belonging to the specified name (items). Multiple items can be specified. +.sp diff --git a/doc/man/sde-export.1 b/doc/man/sde-export.1 new file mode 100644 index 0000000..cd91514 --- /dev/null +++ b/doc/man/sde-export.1 @@ -0,0 +1,22 @@ +.\" Title: sde-export +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-EXPORT" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-export \- Export stuff out of the system +.SH "SYNOPSIS" +\fIsde export\fR [OPTIONS] +.sp +.SH "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. +.sp +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. +.sp diff --git a/doc/man/sde-help.1 b/doc/man/sde-help.1 new file mode 100644 index 0000000..2de91f0 --- /dev/null +++ b/doc/man/sde-help.1 @@ -0,0 +1,20 @@ +.\" Title: sde-help +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-HELP" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-help \- provides help about the usage of the 'sde' wrapper +.SH "SYNOPSIS" +\fIsde help\fR [COMMAND] +.sp +.SH "DESCRIPTION" +Provides help about the commands available for the \fIsde\fR wrapper on the current tree. +.sp diff --git a/doc/man/sde-import.1 b/doc/man/sde-import.1 new file mode 100644 index 0000000..7c7ebc6 --- /dev/null +++ b/doc/man/sde-import.1 @@ -0,0 +1,20 @@ +.\" Title: sde-import +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-IMPORT" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-import \- import stuff into the system +.SH "SYNOPSIS" +\fIsde import\fR [OPTIONS] +.sp +.SH "DESCRIPTION" +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. +.sp diff --git a/doc/man/sde-install.1 b/doc/man/sde-install.1 new file mode 100644 index 0000000..7c60d9f --- /dev/null +++ b/doc/man/sde-install.1 @@ -0,0 +1,20 @@ +.\" Title: sde-install +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-INSTALL" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-install \- install the wrapper +.SH "SYNOPSIS" +\fIsde install\fR +.sp +.SH "DESCRIPTION" +Install the sde wrapper on \fI$HOME/bin\fR which is expected to be on your \fI$PATH\fR. +.sp diff --git a/doc/man/sde-list.1 b/doc/man/sde-list.1 new file mode 100644 index 0000000..c7ee901 --- /dev/null +++ b/doc/man/sde-list.1 @@ -0,0 +1,70 @@ +.\" Title: sde-list +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-LIST" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-list \- produce lists needed by other commands +.SH "SYNOPSIS" +\fIsde list\fR [DISCRIMINATOR] [OPTIONS] +.sp +.SH "DISCRIMINATORS" +.PP +package, pkg +.RS 4 +packages +.RE +.PP +download +.RS 4 +downloadable files of a list of packages, or all if no package is given +.RE +.SH "OPTIONS FOR PACKAGES" +.PP +\-a, \-\-arch +.RS 4 +list the packages available for the specified architecture +.RE +.PP +\-c, \-\-cfg +.RS 4 +list the packages active for the specified config +.RE +.SH "OPTIONS FOR DOWNLOAD" +.PP +\-c, \-\-cfg +.RS 4 +list the download files needed for a given config. +.RE +.PP +\-r, \-\-repositories +.RS 4 +the given list is a list of repositories, not packages. +.RE +.PP +\-a, \-\-all +.RS 4 +list the download files of every package available independent of the rest of the provided options. +.RE +.PP +\-\-dependencies +.RS 4 +include the download files of the active dependencies on the specified config. +.RE +.PP +\-\-checksum +.RS 4 +include the checksum value when listing. +.RE +.PP +\-\-location +.RS 4 +include the download location when listing. +.RE diff --git a/doc/man/sde-update.1 b/doc/man/sde-update.1 new file mode 100644 index 0000000..a21da6f --- /dev/null +++ b/doc/man/sde-update.1 @@ -0,0 +1,20 @@ +.\" Title: sde-update +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE\-UPDATE" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde\-update \- updates part of the system with upstream info +.SH "SYNOPSIS" +\fIsde update\fR [OPTIONS] +.sp +.SH "DESCRIPTION" +TODO +.sp diff --git a/doc/man/sde.1 b/doc/man/sde.1 new file mode 100644 index 0000000..e088e16 --- /dev/null +++ b/doc/man/sde.1 @@ -0,0 +1,20 @@ +.\" Title: sde +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 +.\" Date: 07/10/2007 +.\" Manual: +.\" Source: +.\" +.TH "SDE" "1" "07/10/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +sde \- front end wrapper +.SH "SYNOPSIS" +\fIsde\fR [COMMAND] [DISCRIMINATOR] [OPTIONS] +.sp +.SH "DESCRIPTION" +The sde frontend wrapper is supposed to help to use the \fIsde\fR commands from within multiple \fIsde\fR trees, from \fI$PATH\fR +.sp