aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 8f24c7e89b6831ed66a63214767172233596f104 (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
59
60
61
62
63
64
65
66
67
68
69
cpt-extra
---------

This is a repository for cpt utilities that do not belong with
the rest of the utilities. These are non-essential scripts that
someone could make use of in their scripts. Some of them can be
used for repository management, so I think maintainers could be
interested in a variety of utilities here.


Install
-------

Those scripts currently only depend on cpt (and dependencies of
cpt).

You can install by doing

    find . -type f -name 'cpt-*' | while read -r script; do
        install -Dm755 "$script" "/usr/local/bin/${script##*/}"
    done


Or install the `cpt-extra` package on Carbs Linux.


Repository structure
--------------------

Scripts are dividied into categoried folders.


    /
    ├── alt   - scripts related to the alternatives system.
    ├── other - self explanatory
    └── repo  - scripts for repository management
        └── git  - scripts for git operations, commit messages etc.


New Scripts
-----------

New scripts should be added in a standard manner. You should
keep these in mind,

It should start with a docstring right after the shebang. No
empty line in between.

    #!/bin/sh
    # A docstring explaining the script


It should provide a usage if '--help' or '-h' is provided as an
argument. If you script takes any arguments, it should also display
a usage if not argument is given.

Usage should exit with 0 status code, and should be printed to the
standard output, not stderr. Usage should be a single line string
small and to the point.

    case "$1" in ''|--help|-h) printf 'usage......'; exit 0; esac


Licensing
---------

This repository contains scripts that were initially in the package
manager itself. Some of these were initially authored by Dylan Araps.
License notices are made where needed.