autils

Unnamed repository; edit this file 'description' to name the repository.
git clone https://codeberg.org/emmett1/autils
Log | Files | Refs | README | LICENSE

apkg.md (3610B)


      1 # NAME
      2 
      3 **apkg** - package building tool and package manager for alice linux
      4 
      5 # SYNOPSIS
      6 
      7 **apkg** [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-g] [-h] [*pkg(s)*]
      8 
      9 # DESCRIPTION
     10 
     11 **apkg** is the package build tool and package installer, along with **spm** for the alice linux distribution.
     12 It is written in posix shell with the goal to be simple and effective. It can consume package building templates in the abuild format
     13 and automate the building and installing of packages.
     14 
     15 # OPTIONS
     16 
     17 Arguments for apkg are as follows:
     18 
     19 - **-h**				Print help.
     20 -  **-i** *<pkg(s)>*	Install package(s) without taking dependencies into account. Building will fail if the dependencies are not present in the system.
     21 -  **-I** *<pkg(s)>*	Install package(s) with dependencies.
     22 -  **-d** *<pkg>*       List only direct package dependencies
     23 -  **-D** *<pkg(s)>*    List all dependencies for package(s)
     24 -  **-j** *<pkg>*       List all reverse dependencies for the package (packages that depend on it).
     25 -  **-u** *<pkg(s)>*	Upgrade package(s)
     26 -  **-r** *<pkg(s)>*	Remove package(s)
     27 -  **-t** *<pkg(s)>*	Run scripts for package(s) that update cache or dbs (mime, font cache e.t.c)
     28 -  **-U**				Update system
     29 -  **-f**				Force rebuild a package.
     30 -  **-o** *<pkg(s)>*	Only download source for package(s), do not build and install
     31 -  **-p** *<pkg(s)>*	Print full path to the package build template directory
     32 -  **-s** *<pattern>*	Search for packages
     33 -  **-g** *<pkg>*		Update or generate checksum(s) for the package source files.
     34 
     35 # ENVIRONMENT VARIABLES
     36 
     37 - `APKG_ROOT`		Overrides default root location (/), where sw is installed
     38 - `APKG_CONF`		Overrides default location for the configuration file apkg.conf. The default is under /etc on an installed alice linux system.
     39 - `APKG_NOPROMPT`		If set, it enabled non-interactive use by disabling user confirmation prompt.
     40 - `APKG_REPO`			Double-quoted, space-separated list for the local directories that contain build templates.
     41 - `APKG_PACKAGE_DIR`		Directory where the compiled packages will reside.
     42 - `APKG_SOURCE_DIR`		Directory that will hold the downloaded sources.
     43 - `APKG_WORK_DIR`			Directory where the actual building process will take place. This happens in subdirectories which are cleaned after completion.
     44 - `APKG_LOG`		If set, it enables the creation of a log for the program output.
     45 
     46 **Note:** Usually, APKG_REPO, APKG_PACKAGE_DIR, APKG_SOURCE_DIR and APKG_WORK_DIR are declared in the apkg.conf configuration file. For more information, please see apkg.conf(5).
     47 
     48 # FILES
     49 
     50 - **apkg.conf(5)** is the default configuration file, it resides by default under /etc.
     51 - **abuild** is the name of the package templates that apkg uses, along with relevant files in order to
     52 build and installed packages. For example, one can look to the alice linux repos, under https://codeberg.org/emmett1/alicelinux/src/branch/main/repos
     53 
     54 # EXAMPLES
     55 
     56 `apkg -i linux` - Install the *linux* package
     57 
     58 `apkg -f jupp` - Force rebuild the *jupp* package. If someone tries with just `-i`, `apkg` will produce the following message
     59 if the package is already installed: `[...] Package 'jupp' already installed.`
     60 
     61 `apkg -s icon` - Search for packages names that contain "icon", it will produce a list with one
     62 package per line.
     63 
     64 # AUTHORS
     65 
     66 emmett1 <emmett1.2miligrams@protonmail.com> Author of the program and creator of alice linux.
     67 
     68 mobinmob <mobinmob@disroot.org> Author of the man page.
     69 
     70 # REPORTING BUGS
     71 
     72 **apkg** is in a working stage but also under heavy development. Please report and bugs/issues in the project issue tracker: https://codeberg.org/emmett1/autils/issues