| 1 |
This document describes the general use of DSSS. |
|---|
| 2 |
|
|---|
| 3 |
|
|---|
| 4 |
== Building Software with DSSS == |
|---|
| 5 |
|
|---|
| 6 |
Most D software can be built with DSSS, but if it hasn't been set up for DSSS |
|---|
| 7 |
the process is more complicated. To make things simple, we assume that the |
|---|
| 8 |
software you're trying to compile has already been set up to use DSSS - if it |
|---|
| 9 |
has not, read README.software_engineers. |
|---|
| 10 |
|
|---|
| 11 |
Building software is quite easy. You simply have to extract the sources, and |
|---|
| 12 |
change your directory to that of the sources, then invoke DSSS: |
|---|
| 13 |
$ dsss build |
|---|
| 14 |
|
|---|
| 15 |
DSSS will then proceed to build the software. 'dsss build' has several options, |
|---|
| 16 |
but they're generally only useful for software distribution maintainers. You |
|---|
| 17 |
can attain more information on them with the command: |
|---|
| 18 |
$ dsss build --help |
|---|
| 19 |
|
|---|
| 20 |
You can build only a specified target by simply adding it to the command line: |
|---|
| 21 |
$ dsss build dzipper |
|---|
| 22 |
|
|---|
| 23 |
Of particular use is the option --doc, which generates .html documentation from |
|---|
| 24 |
DDoc comments of compiled libraries: |
|---|
| 25 |
$ dsss build --doc |
|---|
| 26 |
|
|---|
| 27 |
You can make DSSS remove all of the intermediate files it created, leaving only |
|---|
| 28 |
the fully-compiled binaries and libraries, with the command: |
|---|
| 29 |
$ dsss clean |
|---|
| 30 |
|
|---|
| 31 |
Finally, you can cause DSSS to remove /all/ compiled files, essentially leaving |
|---|
| 32 |
the source directory as it was before DSSS was used at all, with the command: |
|---|
| 33 |
$ dsss distclean |
|---|
| 34 |
|
|---|
| 35 |
If you'd like certain flags to be included whenever you call DSSS, you can add |
|---|
| 36 |
them to your DSSS RC file: ~/.dsssrc on POSIX, dsss.rc next to dsss.exe on |
|---|
| 37 |
Windows. |
|---|
| 38 |
|
|---|
| 39 |
|
|---|
| 40 |
== Installing Software with DSSS == |
|---|
| 41 |
|
|---|
| 42 |
Some software can be used directly after building, but most software, libraries |
|---|
| 43 |
in particular, expect to be installed somewhere. DSSS can install software to |
|---|
| 44 |
any directory you choose, but will default to its own directory. After |
|---|
| 45 |
building, to install software to the default directory (provided by DSSS), |
|---|
| 46 |
invoke DSSS with the command: |
|---|
| 47 |
$ dsss install |
|---|
| 48 |
|
|---|
| 49 |
If you'd like to install the software to some other directory, you can specify |
|---|
| 50 |
that directory with the "--prefix" option to DSSS, like so: |
|---|
| 51 |
$ dsss install --prefix=<directory> |
|---|
| 52 |
|
|---|
| 53 |
If you generated documentation at build time, and would like to install that |
|---|
| 54 |
documentation, use the --doc flag to `dsss install`: |
|---|
| 55 |
$ dsss install --doc |
|---|
| 56 |
|
|---|
| 57 |
You can also uninstall previously installed software. For example, to uninstall |
|---|
| 58 |
the hypothetical package "dhello": |
|---|
| 59 |
$ dsss uninstall dhello |
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 |
== Acquiring Software with DSSS == |
|---|
| 63 |
|
|---|
| 64 |
A very convenient feature of DSSS is its ability to install software from the |
|---|
| 65 |
Internet. To install the hypothetical package "dhello" from DSSS' Internet |
|---|
| 66 |
repository, use the command: |
|---|
| 67 |
$ dsss net install dhello |
|---|
| 68 |
|
|---|
| 69 |
Furthermore, DSSS can, from a source directory, install all of the dependencies |
|---|
| 70 |
of that source. This allows developers to not concern themselves with whether |
|---|
| 71 |
the dependencies for their software is installed, or where the sources come |
|---|
| 72 |
from. To install the dependencies for the software you're building, just invoke |
|---|
| 73 |
DSSS with the command: |
|---|
| 74 |
$ dsss net deps |
|---|
