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
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, clean indicates tidying things up or removing it completely
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.
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.
sde\-download downloads one or more packages indicated or belonging to the specified name (items). Multiple items can be specified.
sde\-download downloads one or more packages indicated by or belonging to the specified items. Multiple items can be specified.
.sp
.SH "DISCRIMINATORS"
.PP
config, cfg
\fBconfig, cfg\fR
.RS 4
Downloads all selected packages in the specified config (item).
.RE
.PP
package, pkg
\fBpackage, pkg\fR
.RS 4
Downloads single packages specified by item.
.RE
.PP
repository, repo
\fBrepository, repo\fR
.RS 4
Downloads all packages in the repositories specified by item.
.RE
.SH "OPTIONS"
When no discriminitor is given on the command line the current working directory will be used to determine the discriminator. If still no discriminator can be determined, the \fBpackage\fR discriminator will be used.
.sp
.SH "OPTIONS FOR ALL DISCRIMINATORS"
.PP
\fB\-q, \-\-quiet\fR
.RS 4
Reduces feedback to an absolute minimum.
.RE
.PP
\-q, \-\-quiet
\fB\-v, \-\-verbose\fR
.RS 4
Reduces feedback to an absolute minimum. \-v, \-\-verbose: Gives additional feedback.
Gives additional feedback.
.RE
.PP
\-n, \-\-dry\-run
\fB\-n, \-\-dry\-run\fR
.RS 4
No real download is performed but the list of missing files is output.
Process normally, but instead of downloading missing files a message will be written to the terminal for every missing file.
.RE
.PP
\-\-timeout
\fB\-\-timeout none|normal|long\fR
.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.
\fBnormal\fR. Other values are
\fBnone\fR
for no timeout at all and
\fBlong\fR
for a longer than normal timeout.
.RE
.PP
\-\-check
\fB\-\-check never|download|always\fR
.RS 4
Defines when will the tool validate the downloaded file against the checksum in the database. The default 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.
Defines when downloads should be checked against the checksum in package
\fB.desc\fR
files. By default checksums will
\fBalways\fR
checked. Other possible values are
\fBnever\fR
to disable checksum verification and
\fBdownload\fR
to only verify on downloading. In this last case checksums will not be validated when an alternative (\fB\-\-alt\-dir\fR) download location is used.
.RE
.PP
\-\-mirror
\fB\-\-mirror none|auto|URL\fR
.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.
Defines which mirror to use. Whatever is selected here overrides the default stored on the global config settings. Alternatively you can use
\fBnone\fR
for disabling mirroring or
\fBauto\fR
to detect the best mirror for your location.
.RE
.PP
\-\-alt\-dir
\fB\-\-alt\-dir location\fR
.RS 4
Defines a local place where look initially for the files, and then includes on the current working tree by the choosen mode. (see \-\-mode)
Defines an alternative download location. The OpenSDe downloader will first look for files in this location. When not present download will continue as usual. Also have a look at option
\fB\-\-mode\fR.
.RE
.PP
\-m, \-\-mode
\fB\-m, \-\-mode hardlink|copy|move\fR
.RS 4
Defines what to do when taking a file from
\fI$altdir\fR. By default it makes a
\fIhardlink\fR, but you can also choose
\fIcopy\fR
or
\fImove\fR.
Defines how files from an alternative download location will be handled. By default a
\fBhardlink\fR
to these files will be created. Other options are
\fBcopy\fR
and
\fBmove\fR
to copy/move the file over to the local download repository.
.RE
.SH "OPTIONS FOR PACKAGE AND REPOSITORY DISCRIMINATORS"
.PP
\-e, \-\-extenders
\fB\-e, \-\-extenders configname\fR
.RS 4
When using
\fIpackage\fR
or
\fIrepository\fR
discriminators, download the active extenders considering the specified config id.
Besided downloading files for specified packages, also downloads for packages extending the given packages will be retrieved. However only the extenders activated in the given config will be taken into account.
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.
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.
Exports part of the sde system specified by item. All information belonging to the specified item will be wrapped up in a single bundle and written to the specified file. This file can be imported (\fBsde import\fR) again later or on a different host elsewhere. This command is ideal for sending information to the opensde mailing list or sharing uncommitted changes with co\-workers.
.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.
.SH "DISCRIMINATORS"
.PP
\fBconfig, cfg\fR
.RS 4
Wraps up the config specified by item and writes it to the specified file. Besides the config information, also information about the host system is included. This is needed to detect difference between the current host and the target system where the exported results will be imported.
.RE
.PP
\fBpackage, pkg\fR
.RS 4
Wraps up the package specified by item and writes it to the specified file. Besides the package content, also the fully qualified package name will be stored. This is needed to be able to recreate the package at the exact same location on import.
.RE
.PP
\fBtarget, tgt\fR
.RS 4
Wraps up the target specified by item and writes it to the specified file.
.RE
.SH "OPTIONS FOR ALL DISCRIMINATORS"
.PP
\fB\-f, \-\-force\fR
.RS 4
Makes it possible to overwrite existing files. Normally processing abort when the given file already exists.
.RE
.SH "OPTIONS FOR PACKAGE AND TARGET DISCRIMINATORS"
.PP
\fB\-d, \-\-diff\fR
.RS 4
Only wraps up changes to reduce filesize.
.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.
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
sde\-help \- provides help about the usage of the 'sde' wrapper
sde\-help \- provides help about the usage of the *sde* wrapper
.SH "SYNOPSIS"
\fIsde help\fR [COMMAND]
\fBsde help\fR [\fICOMMAND\fR]
.sp
.SH "DESCRIPTION"
Provides help about the commands available for the \fIsde\fR wrapper on the current tree.
Provides help about the commands available for the \fBsde\fR wrapper on the current tree. To see a full list of available commands, issue the \fBsde help\fR without any arguments. To get help on a specific command, use that command as an argument
.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.
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
sde\-install \- install the wrapper
sde\-install \- Takes care of installingsoftware on you host system.
.SH "SYNOPSIS"
\fIsde install\fR
\fBsde install\fR
.sp
.SH "DESCRIPTION"
Install the sde wrapper on \fI$HOME/bin\fR which is expected to be on your \fI$PATH\fR.
Install the \fBsde\fR wrapper on \fB$HOME/bin\fR which is expected to be on your \fB$PATH\fR. The \fBsde\fR wrapper is only copied if the current version is newer than an existing one.
.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.
downloadable files of a list of packages, or all if no package is given
.RE
.SH "OPTIONS FOR PACKAGES"
.PP
\-a, \-\-arch
\fB\-a, \-\-arch\fR
.RS 4
list the packages available for the specified architecture, ignoring the given items and other options.
.RE
.PP
\-c, \-\-cfg
\fB\-c, \-\-cfg\fR
.RS 4
use an specified config to see the active packages, instead of all of them.
.RE
.PP
\-r, \-\-repositories
\fB\-r, \-\-repositories\fR
.RS 4
the given list is a list of repositories, not packages.
.RE
.PP
\-e, \-\-extenders
\fB\-e, \-\-extenders\fR
.RS 4
include the packages which extend the given items.
.RE
.SH "OPTIONS FOR DOWNLOAD"
.PP
\-c, \-\-cfg
\fB\-c, \-\-cfg\fR
.RS 4
list the download files needed for a given config.
.RE
.PP
\-r, \-\-repositories
\fB\-r, \-\-repositories\fR
.RS 4
the given list is a list of repositories, not packages.
.RE
.PP
\-e, \-\-extenders
\fB\-e, \-\-extenders\fR
.RS 4
include the download files of the active extenders on the specified config.
.RE
.PP
\-p,\-\-package
\fB\-p,\-\-package\fR
.RS 4
include the package name when listing
.RE
.PP
\-k, \-\-checksum
\fB\-k, \-\-checksum\fR
.RS 4
include the checksum value when listing.
.RE
.PP
\-l, \-\-location
\fB\-l, \-\-location\fR
.RS 4
include the download location when listing.
.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.
Synchronizes part of the environment to the latest version from the repository. Depending on the discriminator specified either the package tree, an identified target, the OpenSDE framework or all of then will get synchronized
Synchronizes part of the environment to the latest version from the repository. Depending on the discriminator specified either the package tree, an identified target, the OpenSDE framework or all of then will get synchronized with upstream changes.
.sp
.SH "DISCRIMINATORS"
.PP
all
\fBall\fR
.RS 4
Synchronizes everything (system, packages and targets) to the latest changes in the upstream repository. However, only items that actually came from a repository will get synchronized. Other items will not be touched. This discriminator does not require any items to be specified.
.RE
.PP
package, pkg
\fBpackage, pkg\fR
.RS 4
Synchronizes the package tree to the latest changes in the upstream repository. This discriminator does not require any items to be specified.
.RE
.PP
system, sys
\fBsystem, sys\fR
.RS 4
Synchronizes the OpenSDE framework to the latest changes in the upstream repository. This discriminator does not require any items to be specified.
.RE
.PP
target, tgt
\fBtarget, tgt\fR
.RS 4
Synchronizes the specified target to the latest changes in the upstream repository, but only if it originally came from a repository. If the specified target does not originally come from a repository this command will result in an error message.
.RE
@ -43,7 +43,7 @@ When no discriminator is specified, then the default discriminator depends on th
.sp
.SH "OPTIONS"
.PP
\-v, \-\-verbose
\fB\-v, \-\-verbose\fR
.RS 4
Give additional feedback on what is happening.
.RE
@ -58,3 +58,12 @@ sde sync package
sde sync target koala
.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.
Updates part of the environment to the latest version from the repository. Depending on the discriminator specified either a package or a target can get updated.
.sp
.SH "DISCRIMINATORS"
.PP
package, pkg
\fBpackage, pkg\fR
.RS 4
Updates the package specified as item to the given version.
.RE
.PP
target, tgt
\fBtarget, tgt\fR
.RS 4
Updates the target specified as item to the given version. Details for updating will be taken from the OpenSDE Seedlings target database. When the target is not in the Seedlings target database this command results into and error message.
.RE
@ -33,7 +33,7 @@ When no discriminator is specified, package is used as the default discriminator
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.
The sde frontend wrapper is supposed to help to use the \fIsde\fR commands from within multiple \fIsde\fR trees, from \fI$PATH\fR
The \fBsde\fR frontend wrapper is a single command to access all OpenSDE functionality. It is a wrapper since it wraps all existing commands in a single interface. Beyond this simple wrapping the command makes it also possible to work with separate sde environments. For this the environment variable \fBSDEROOT\fR is used.
.sp
.SH "COMMANDS"
Various commands are available, each one targeting a special operation. Amongst these commands are:
.sp
.sp
.RS 4
.nf
build \- building packages
clean \- cleaning part of your environment
config \- configuring part of your environment
create \- creating new packages or target
download \- downloading packages
install \- installing sde or packages on your current system
update \- updating packages
.fi
.RE
For a complete list of commands execute the following command: sde help
.sp
.SH "DISCRIMINATORS"
OpenSDE supports various discriminators, however what discriminators are valid depends on the command being used.
.sp
.SH "ENVIRONMENT"
.PP
\fBSDEROOT\fR
.RS 4
When
\fBSDEROOT\fR
is set, sde uses it as the path to your sde environment. If not specified the current working directory is used.
.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.
Imports the specified filename into the opensde environment under the name specified by item. If no item name is specified the original name as stored in the imported file will be used. The content of the specified file needs 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
.SH "DISCRIMINATORS"
.PP
\fBconfig, cfg\fR
.RS 4
Forces the imported file to be a config.
.RE
.PP
\fBpackage, pkg\fR
.RS 4
Forces the imported file to be a package.
.RE
.PP
\fBtarget, tgt\fR
.RS 4
Forces the imported file to be a target.
.RE
When no discriminator specified the imported file will be processed without checking against a discriminator.
.sp
.SH "OPTIONS FOR ALL DISCRIMINATORS"
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Instead of really importing the file it is normally processed but not imported. This can be used to see what would happen if the file were imported.
.RE
.PP
\fB\-f, \-\-force\fR
.RS 4
Makes it possible to overwrite existing items with imported information.
.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.