qi/doc/qi.1.in

   1 #! /bin/sh -
   2 # This file is part of the Qi distribution.
   3 #
   4 # A dummy copy as part of generating and organizing the help2man output.
   5 #
   6
   7 PROGRAM=qi
   8
   9 usage()
  10 {
  11     printf '%s' \
  12 "Usage: $PROGRAM COMMAND [OPTIONS] [FILE]...
  13 "'Qi is a simple but well-integrated package manager.  It can create,
  14 install, remove, and upgrade software packages.  Qi produces binary
  15 packages using recipes, which are files containing specific instructions
  16 to build each package from source.  Qi can manage multiple packages
  17 under a single directory hierarchy.  This method allows to maintain a
  18 set of packages and multiple versions of them.  This means that Qi could
  19 be used as the main package manager or complement the existing one.
  20
  21 Options:
  22
  23 List of commands:
  24   warn                     Warn about files that will be installed
  25   install                  Install packages
  26   remove                   Remove packages
  27   upgrade                  Upgrade packages
  28   extract                  Extract packages for debugging purposes
  29   create                   Create a .tlz package from directory
  30   build                    Build packages using recipe names
  31   order                    Resolve build order through .order files
  32
  33 Options when installing, removing, or upgrading software packages:
  34   -f, --force              Force upgrade of pre-existing packages
  35   -k, --keep               Keep package directory when remove/upgrade
  36   -p, --prune              Prune conflicts
  37   -P, --packagedir=<dir>   Set directory for package installations
  38   -t, --targetdir=<dir>    Set target directory for symbolic links
  39   -r, --rootdir=<dir>      Use the fully qualified named directory as
  40                            the root directory for all qi operations
  41                            Note: the target directory and the package
  42                            directory will be relative to the specified
  43                            directory, excepting the graft log file
  44
  45 Options when building software packages using recipes:
  46   -a, --architecture       Set architecture name for the package
  47   -j, --jobs               Parallel jobs for the compiler
  48   -k, --keep               Keep ${srcdir} or ${destdir} when build
  49   -S, --skip-questions     Skip questions on completed recipes
  50   -1, --increment          Increment release number (${release} + 1)
  51   -n, --no-package         Do not create a .tlz package
  52   -i, --install            Install package after the build
  53   -u, --upgrade            Upgrade package after the build
  54   -o, --outdir=<dir>       Where the packages produced will be written
  55   -w, --worktree=<dir>     Where archives, patches, recipes are expected
  56   -s, --sourcedir=<dir>    Where compressed sources will be found
  57
  58 Other options:
  59   -N, --no-rc              Do not read the configuration file
  60   -v, --verbose            Be verbose (an extra -v gives more)
  61   -L, --show-location      Print default directory locations and exit
  62   -h, --help               Display this help and exit
  63   -V, --version            Output version information and exit
  64
  65 Environment:
  66
  67 Some influential environment variables:
  68   TMPDIR                   Temporary directory for sources
  69   QICFLAGS                 C compiler flags (to be used on CFLAGS)
  70   QICXXFLAGS               C++ compiler flags (to be used on CXXFLAGS)
  71   QILDFLAGS                Flags for the linker (to be used on LDFLAGS)
  72   QICPPFLAGS               C/C++ preprocessor flags (to be used on CPPFLAGS)
  73   SOURCE_DATE_EPOCH        Last modification time for created packages
  74 '
  75 }
  76
  77 if test "$1" = --help
  78 then
  79     usage
  80 fi
  81