aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 9ea2dc3666da1fb54a59e49c9e28a9f19df25534 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Carbs Packaging Tools
=====================

Package management toolset for Carbs Linux. Forked from KISS[1]. All usage
information can be obtained from the manual page. Refer to the ChangeLog[2] to
learn what's new.


Dependencies
------------

To build and use cpt, you need the following software:

- rsync
- curl
- POSIX base utilities  [coreutils, busybox, sbase, etc.]
- pax or tar            [GNU tar, busybox, toybox, libarchive, etc.]
- Common compression utilities such as `gzip`, `bzip2`, `xz`, etc.


In order to build the documentation from source, you will need the following
software:

- GNU Texinfo (for generating `.info` pages)
- GNU Emacs   (for generating `.texi` and `.txt` pages)

However, distributed tarballs come with info pages, and `.texi` and `.txt` files
are committed directly into the repository, meaning that you don't need Texinfo
if you are using a tarball, and you don't need Emacs as long as you don't edit
the documentation.

You can also completely disable the build/installation of the documentation by
either passing `DOCS=no` to `make` or editing `config.mk` to disable it.


Installation
------------

In order to install CPT, you can run the following with `make`:

    make
    make PREFIX=/usr install


Documentation
-------------

The documentation for each tool along with some examples can be found on
manpages installed with the package manager. User manual of CPT can be found
online[3], or installed as both plain-text and as info pages. Without any
changes to the Makefile configuration those files can be found at:

- /usr/local/share/docs/cpt/cpt.txt
- /usr/local/share/info/cpt.info

[1]: https://github.com/kisslinux/kiss
[2]: https://fossil.carbslinux.org/cpt/log
[3]: https://carbslinux.org/docs/cpt