stklos-pkg.1.in 4.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
.\" -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH STKLOS-PKG 1 "version @VERSION@"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
stklos-pkg \- ScmPkg packages management

.SH SYNOPSIS
\fbstklos-pkg\fR [\fIoptions\fR]

.SH DESCRIPTION
The
.B stklos-pkg
command is the general tool for downloading, installing and  uninstalling
28 29
.B ScmPkg
packages in STklos.
30 31 32
.LP
The first time you use stklos-pkg you must synchronize your local
repository with the ScmPkg server. This is done using the
33 34
\fI--setup\fR option. The other options of stklos-pkg are described
below.
35 36

.SH OPTIONS
37
Here are the options available in the version @VERSION@ of
38 39
.B stklos.

40
.IP "--extract package | -e package"
41 42 43 44
extract the files of  \fIpackage\fR (and all its dependencies) and build a
Unix Makefile for compiling the package. The files are extracted in the
directory specified with option \fI--directory\fR (or the current
directory if the option is unused. The generated Makefile offers the
45
following targets:
46
.RS
47
.IP  "all"
48
to build the package dependencies nd the package itself
49
.IP "test"
50
to run package tests
51
.IP "install"
52
to install the package (and its dependencies) for the current user
53 54
.IP "   system-install"
to install the package (and its dependencies) system-wide
55 56 57
.RE

.IP "--test=package | -t package"
58 59
extract and test the given package in a temporary directory. If the
test succeeds, the \fIstklos-pkg\fR command returns 0.
60 61 62 63

.IP "--install=package| -i package"
install the given package and its dependencies in the standard
installation directory. If the \fI--system-wide\fR flag is not used, files
64 65
are installed in the user directory. Otherwise, files are installed in
a shared directory available to all users.
66 67 68 69 70 71 72

.IP "--uninstall package"
un-install the files which were copied during the installation of the
given package. Use the \fI--system-wide\fR option to un-install shared files.

.IP "--sync | -s"
synchronize the local repository on the ScmPkg server(s). This will
73
download the description of all the packages which are available on
74
the server(s). The packages themselves are downloaded, only when
75
needed.
76 77

.IP "--add=package| -a package"
78
adds the given package to the repository.
79

80 81 82 83 84
.IP "--download=package"
download the tarball associated to given package and copy it in the
current directory or the directory specified by the "--directory"
option.

85
.IP "--fill-cache"
86 87 88 89
downloads all the package which are available on the server(s). This
can be used for copying all remote packages, when the net connection
is not permanent for instance.

90 91 92
.IP "--clear-cache"
remove all the packages from the cache. This can be used when packages
files take too much place. Packages will be downloaded when needed
93 94 95 96

.IP "--reset"
remove all the files needed by ScmPkg, that is the cache of packages,
but also the binary of installed packages, their documentation, and
97
all the meta-data of ScmPkg.
98 99 100

.IP "--list |-l"
list all the packages which are available from server(s) and from the
101
current repository.
102 103 104 105

.IP "--depends=package"
list the packages needed by the given package

106
.IP "--installed"
107 108
list the packages which are locally installed

109 110 111
.IP "--conf-dir=dir | -D dir"
Use the specified directory  as stklos main configuration
directory. This is useful if you use stklos(1) with the \fI-D\fR
112 113
option. Note that you can use the \fI-STKLOS_CONFDIR\fR shell variable
for that too.
114

115 116 117 118 119
.IP "--directory=dir | -C dir"
Use the specified directory for extracting file. If this option is not
specified, files are extracted in the current directory.

.IP "--verbose | -v"
120
be more verbose. Several usage of this flag increase the verbosity of
121 122 123
stklos-pkg.

.IP "--system-wide | -S"
124
flag used to indicate that (un-)installation must be system wide.
125 126

.IP "--version |-V"
127
display the version of \fIstklos-pkg\fR and exit.
128 129 130 131 132

.IP "--help | -h"
Show a list of options

.SH "FILES"
133 134
.IP "~/<stklos-conf-dir>/pkg"
The \fISTklos\fR user ScmPkg repository. <stklos-conf-dir> is by
135
default \fI~/.stklos\fR but can be set by the \fiSTKLOS_CONFDIR\fR
136 137
shell variable

138
.IP "@PREFIX@/lib/stklos/pkg"
139
The \fISTklos\fR system ScmPkg repository here
140

141 142 143
.SH ENVIRONMENT VARIABLES

.IP "STKLOS_CONFDIR"
144 145
This variable can be used to designate the directory used by \fBstklos\fR
to store its configuration or packages files. It not set, the default
146 147
\fBstklos\fR configuration directory is by default \fB~/.stklos\fR.

148 149 150

.SH "SEE ALSO"
.BR stklos (1)