can/README.org
2026-02-05 22:05:32 +01:00

36 lines
1.3 KiB
Org Mode

* Installing
Run ~gmake~ to build, then ~gmake install~ to install. The Makefile tries to autodetect the platform, but one
can be passed with ~PLATFORM=...~ to override.
Tested platforms:
- FreeBSD
- Linux (Gentoo)
- NetBSD
- OpenBSD
- SunOS (OpenIndiana)
** Dependencies
*** Build time
- C23 compiler
- [[https://www.gnu.org/software/make][gmake]]
- [[https://www.freedesktop.org/wiki/Software/pkg-config][pkg-config]] or [[https://pkgconf.org][pkgconf]] (Linux only)
*** Run time
- [[https://libbsd.freedesktop.org/wiki][libbsd]] (Linux only)
* Usage
~can [-GghqU] [--gid] [--group] [--help] [--quiet] [--uid] user action path~
See ~cwm(1)~ for details.
* TODOs
** TODO Test compatibility with other *nix systems
* License
*can* is licensed under the GNU General Public License version 3 *only*.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, exclusively version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see [[https://www.gnu.org/licenses/]].