From ada70823eb5adc441f190a696162720734359eef Mon Sep 17 00:00:00 2001 From: steven-omaha <35634100+steven-omaha@users.noreply.github.com> Date: Fri, 26 May 2023 16:44:25 +0200 Subject: [PATCH] docs(man): add pacdef.8 content --- man/pacdef.8 | 120 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 111 insertions(+), 9 deletions(-) diff --git a/man/pacdef.8 b/man/pacdef.8 index b5c56ba..6552016 100644 --- a/man/pacdef.8 +++ b/man/pacdef.8 @@ -1,22 +1,124 @@ .TH "PACDEF" "8" "2023\-05\-26" "pacdef v1\&.2\&.1" "Pacdef Manual" -.SH "NAME" -pacdef — multi-backend declarative package manager +.SH NAME +pacdef \(em multi-backend declarative package manager .SH SYNOPSIS -.sp -\fIpacdef\fR group -.sp -\fIpacdef\fR package -.sp -\fIpacdef\fR version +\fIpacdef\fR ... +. .SH DESCRIPTION Pacdef ... .SH CONFIGURATION +Configure pacdef in its config file. See +.BR pacdef.yaml(5). + .SH SUBCOMMANDS +The main subcommands are 'group', 'package' and 'version'. + + ... +.RS 4 +All actions related to managing groups. +.sp + [...] +.RS 4 +edit the content of an existing group +.RE +. +.sp + [...] +.RS 4 +import a new group file or group dir structure +.RE +.sp + +.RS 4 +show the sorted names of all imported groups +.RE +.sp + [args] [...] +.RS 4 +create a new group file +.sp +-e|--edit +.RS 4 +After creating the files, open them in your configured editor as configured in +$EDITOR or $VISUAL. +.RE +.RE +.sp + [...] +.RS 4 +remove group file. +\fBWARNING\fR: If the group file is not a symlink, you wil loose the file! +. +.RE +.sp + [...] +.RS 4 +show content of a group file +.RE + +.RE + + + ... +.RS 4 +All actions related to packages. + +.sp + [args] +.RS 4 +remove unmanaged packages +.sp +--noconfirm +.RS 4 +do not ask for confirmation +.RE +.RE +. +.sp + +.RS 4 +for each unmanaged package interactively decide what to do +.RE +.sp + +.RS 4 +show packages that match the regular expression. +.RE +.sp + [args] +.RS 4 +install managed packages + +--noconfirm +.RS 4 +see 'clean' +.RE +.RE +.sp + +.RS 4 +show unmanaged packages +.RE +.RE +.sp +version +.RS 4 +Show version information (including git revision if it was build from git) and supported backends. +.RE + + .SH EXIT STATUS -.SH FILES +Pacdef exits with status 0 on success, 1 if an error occurs (e.g. package search did not yield any package), and 2 if invalid command line options were specified. + .SH BUGS +File bugs and feature requests under https://github.com/steven-omaha/pacdef/issues. + .SH AUTHORS +Mostly 'steven-omaha'. +Contributors under https://github.com/steven-omaha/pacdef/graphs/contributors. + .SH SEE ALSO +.BR pacdef.yaml(5)