From 22f9827e73db950607cf50c069c87ab54af95125 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Mat=C3=ADas=20Fonzo?= Date: Mon, 1 Apr 2019 21:50:45 -0300 Subject: [PATCH] qi: minor changes on code, documentation --- qi/Makefile | 3 +- qi/doc/qi.1 | 60 ++++++++++++++------------- qi/doc/qi.html | 21 +++++----- qi/doc/qi.info | 48 +++++++++++----------- qi/doc/qi.texi | 20 ++++----- qi/src/qi.in | 126 +++++++++++++++++++++++++++++---------------------------- 6 files changed, 142 insertions(+), 136 deletions(-) diff --git a/qi/Makefile b/qi/Makefile index 4b1b6640..b274fe9f 100644 --- a/qi/Makefile +++ b/qi/Makefile @@ -102,7 +102,8 @@ man : doc/qi.1 doc/qi.1 : src/qi LC_ALL=C help2man ${HELP2MAN_OPTS} \ - -n 'a user-friendly package manager' -o $@ src/qi + -n 'a simple but well-integrated package manager' \ + -o $@ src/qi html : doc/$(project).html diff --git a/qi/doc/qi.1 b/qi/doc/qi.1 index 0f1bd442..8aa5ab7a 100644 --- a/qi/doc/qi.1 +++ b/qi/doc/qi.1 @@ -1,16 +1,16 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. -.TH QI "1" "March 2019" "qi 1.0-rc59" "User Commands" +.TH QI "1" "April 2019" "qi 1.0-rc59" "User Commands" .SH NAME -qi \- a user-friendly package manager +qi \- a simple but well-integrated package manager .SH SYNOPSIS .B qi [\fI\,OPTION\/\fR...] [\fI\,FILE\/\fR]... .SH DESCRIPTION -Qi \- A practical and user\-friendly package manager. +Qi \- A user\-friendly package manager. .SS "Operation mode:" .TP \fB\-b\fR -Build packages using recipes +Build packages using recipe names .TP \fB\-c\fR Create .tlz package from directory @@ -28,45 +28,46 @@ Resolve build order through .order files Update packages (implies \fB\-i\fR, \fB\-d\fR with \fB\-p\fR) .TP \fB\-w\fR -Warn about files that will be installed +Warn about files that will be linked .TP \fB\-x\fR -Extract packages for debugging purposes +Extract a package for debugging purposes .SS "Common options:" .TP -\fB\-L\fR -Print default directory locations -.TP \fB\-N\fR -Don't read the configuration file +Do not read the configuration file .TP -\fB\-P\fR - Package directory for (de)installations; +\fB\-P\fR +Package directory for installations. .IP -(only valid for \fB\-i\fR, \fB\-d\fR, or \fB\-u\fR options) +Only valid for \fB\-i\fR, \fB\-d\fR, or \fB\-u\fR options .TP \fB\-f\fR -Force package upgrade -Force build a recipe +This option can force the build of a recipe, +or force the update of a pre\-existing package. +.IP +Only valid for \fB\-b\fR, \fB\-u\fR options .TP -\fB\-t\fR - Target directory for symbolic links +\fB\-t\fR +Target directory for symbolic links. .IP -(only valid for \fB\-i\fR, \fB\-d\fR, or \fB\-u\fR options) +Only valid for \fB\-i\fR, \fB\-d\fR, or \fB\-u\fR options .TP \fB\-k\fR -Keep (don't delete) srcdir or destdir -Keep (don't delete) package directory -(only valid for \fB\-b\fR, \fB\-d\fR or \fB\-u\fR options) +Keep `${srcdir}' or `${destdir}' on build mode, +keep package directory on delete mode. +.IP +Only valid for \fB\-b\fR, \fB\-d\fR or \fB\-u\fR options .TP \fB\-p\fR -Prune conflicts on package (de)installation +Prune conflicts on package installations .TP -\fB\-r\fR -Use the named directory as the root directory -for installing, deleting, or upgrading packages. -The target directory, package directory will be -relative to this specific directory +\fB\-r\fR +Use the fully qualified named directory as the +root directory for all qi operations. The target +directory and package directory will be relative to +the specified directory, including the log file for +graft .TP \fB\-v\fR Be verbose (a 2nd \fB\-v\fR gives more) @@ -88,7 +89,7 @@ Architecture to use [detected] Parallel jobs for the compiler .TP \fB\-1\fR -Increment release number (release + 1) +Increment release number (`${release}' + 1) .TP \fB\-n\fR Don't create a .tlz package @@ -97,6 +98,9 @@ Don't create a .tlz package Selects the option to skip completed recipes .SS "Informative options:" .TP +\fB\-L\fR +Print default directory locations +.TP \fB\-h\fR Display this help and exit .TP diff --git a/qi/doc/qi.html b/qi/doc/qi.html index d9e76aaf..a47ec06c 100644 --- a/qi/doc/qi.html +++ b/qi/doc/qi.html @@ -1,7 +1,7 @@