functions: changed pkginstalled() to use $* instead of "$@" when generating the pattern
[opensde-nopast.git] / doc / sde-wrapper.txt
blob3ef76c43a065c16286f4b23de807888f38156340
1 (R)     the value stay recorded on the tree after the first usage
2 (G)     the value can be specified at $HOME/.sde/config
4 # `sde download`
5 # Grab package files
7 sde download <options>  -all            # Download every file from the tree
8                         [-cfg $config] $pkg [$pkg [...]]
9                                         # Downloads specific packages and their active extenders
10                         -cfg $config    # Download all the files required by a given config
11                         -help           # Shows some help
12         options:
13                         -q                      # quiet mode
14                 (R)     -mirror $mirror         # use a given mirror
15                 (G)     -alt-dir $altdir        # try first from a give path
16                 (G)     -curl-opt $curlopt      # use a given set of arguments for `curl`
17                 (G)     -proxy $proxy           # proxy to use on downloads
18                 (G)     -proxy-auth $proxyuth   # auth info for the proxy
20 # `sde config`
21 # Set up a build
23 sde config <options> [[-cfg] $config]   # configure a build (default: default)
24         options:
25                         -q                      # quick/quiet mode, just refresh
27 # `sde build`
28 # Makes a build
30 sde build       [[-cfg] $config]        # start/continue a given build
31                 [[-cfg] $config] -job [$stage-]$pkg
32                                         # builds certain package on a build
33                 [[-cfg] $config] [-f] -tools [$stage]
34                                         # build some internal tools needed during the build
35                                         # (it's able to detect if they need regeneration or not)
36         options:
37                         -f              # (-tools) force regeneration
39 # `sde new`
40 # Makes a new tree
42 sde new [-branch $branch] $location     # makes a new tree at a given location
44 # `sde update`
45 # Updates a tree
46 sde update <options>            # Updates a tree
47         options:
48                 -v      # verbose
49                 -s      # append summary
51 # `sde commit` (Alias: ci)
52 # Commit changes
54 sde commit <options> [$location [$location [...]]]      # commits changes at give locations
55                                                         # (they can also be package names)
56         options:
57                 -patch  # creates a patch to send by mail
59 # `sde pkg` (Alias: package)
61 sde pkg update $package # recalculate checksum for the files of a package (download if needed)
62         update $package $version [-relocate $newlocation]
63                         # updates a package to a given version, optionally changing the
64                         # download location
65         update $package -check
66                         # check upstream for new versions of this package
67         build $package [-cfg $config] [-stage $stage] [-root $root]
68                         # builds a package
69         new <options> [package/]$repository/$package (-fm|-cpan|-sf|-be) $name
70                         # creates a new package from the info available for a name at a remote source
71                         # fm:freshmeat cpan:CPAN sf:SourceForge be:berlios
72         new <options> [package/]$repository/$package $url [$url [...]]
73                         # creates a new package taking as download files a given list of URLs
75         options:
76                         -v      # (new), verbose package creation
77                         -q      # (new), quiet package creation
78                 (G)     -m $me  # (new), sets the given as the package maintainer
80 # `sde target`
81 # Interacts with the target's directory
83 sde target      list [$flag [$flag [...]]]
84                         # list the targets (and their branches) which are registered for a given
85                         # set of flags
86                 list $target
87                         # list the branches registered on the directory of a give target
88                 update [$target [$target [...]]]
89                         # updates one, more or all the targets on this tree
90                 get $target [-branch $branch]
91                         # gets a read-only copy of a target on the current tree (recursivly)
92                 rename $target $newtarget
93                         # changes the id a target is using on the current tree (and on the configs)
94                 switch $target [-branch $branch] (-ro|-rw)
95                         # change a target to a different branch or between rw/ro repositories
97 # `sde cleanup`
99 sde cleanup                     # removes inactive src.*/ directories lingering around
100                 -download       # removes files at download/ which are no longer needed
101                 -cache          # removes ccache caches
102                 -build $builddir [$builddir [...]]
103                                 # removes complete builddirs