cpt-extra

Extra utilities for cpt
git clone git://git.carbslinux.org/cpt-extra
Log | Files | Refs | README | LICENSE

README (1796B)


      1 cpt-extra
      2 ---------
      3 
      4 This is a repository for cpt utilities that do not belong with
      5 the rest of the utilities. These are non-essential scripts that
      6 someone could make use of in their scripts. Some of them can be
      7 used for repository management, so I think maintainers could be
      8 interested in a variety of utilities here.
      9 
     10 
     11 Install
     12 -------
     13 
     14 Those scripts currently only depend on cpt (and dependencies of
     15 cpt).
     16 
     17 You can install by doing
     18 
     19     find . -type f -name 'cpt-*' | while read -r script; do
     20         install -Dm755 "$script" "/usr/local/bin/${script##*/}"
     21     done
     22 
     23 
     24 Or install the `cpt-extra` package on Carbs Linux.
     25 
     26 
     27 Repository structure
     28 --------------------
     29 
     30 Scripts are dividied into categoried folders.
     31 
     32 
     33     /
     34     ├── alt   - scripts related to the alternatives system.
     35     ├── other - self explanatory
     36     └── repo  - scripts for repository management
     37         └── git  - scripts for git operations, commit messages etc.
     38 
     39 
     40 New Scripts
     41 -----------
     42 
     43 New scripts should be added in a standard manner. You should
     44 keep these in mind,
     45 
     46 It should start with a docstring right after the shebang. No
     47 empty line in between.
     48 
     49     #!/bin/sh
     50     # A docstring explaining the script
     51 
     52 
     53 It should provide a usage if '--help' or '-h' is provided as an
     54 argument. If you script takes any arguments, it should also display
     55 a usage if not argument is given.
     56 
     57 Usage should exit with 0 status code, and should be printed to the
     58 standard output, not stderr. Usage should be a single line string
     59 small and to the point.
     60 
     61     case "$1" in ''|--help|-h) printf 'usage......'; exit 0; esac
     62 
     63 
     64 Licensing
     65 ---------
     66 
     67 This repository contains scripts that were initially in the package
     68 manager itself. Some of these were initially authored by Dylan Araps.
     69 License notices are made where needed.