Document moving docs for aptpkg into man pages

main
earnest ma 1 year ago
parent c11b34ad3f
commit eb7c72be19
Signed by: earnest ma
GPG Key ID: A343F43342EB6E2A
  1. 36
      index.md

@ -34,41 +34,13 @@ We use reprepro, namely these commands:
## aptpkg itself
Easily create Debian packages.
Easily create Debian packages. aptpkg can be used to easily create/ get debian
packages, and can be used with a tool such as **reprepro**(1).
Run `aptpkg --help` or `man aptpkg` for more information.
### Links
- [Git repository](https://git.sr.ht/~earnestma/aptpkg)
- [Mailing list for patches](https://lists.sr.ht/~earnestma/aptpkg-devel)
- [Issue tracker](https://todo.sr.ht/~earnestma/aptpkg)
# build file reference
Feel free to take a peek at the `aptpkg-pkgs` repository.
The `build` file is a shell(?) file loaded in by `aptpkg` and should be located
in its own folder which is named the program.
The first line should be a comment: `# Maintainer: Name or User Name <email@example.org>`
There are currently two types of things aptpkg can process:
1. `type=deb`: Debian packages which are simply downloaded from the URL and
checked
2. `type=file`: Get (a) file(s), check, and execute the `steps` function
This should be defined after `name`, `version`, and `rev` - which is only useful
when `type=file` and should be set to zero after each version update.
`url` should contain the upstream application's source code/ homepage, and
`description` should be similar to what has been provided by them.
`source` contains the URL to download and `sha512sums` contains the output to be verified after.
In the `steps` function (for `type=file`), you can use the following variables and functions:
- `$builddir`
- `cin-bin` to `install` a binary
- `cin-file` to `install` a file
You can also place maintenance files along `build`: `preinst`, `postinst`, `prerm`, and `postrm`.