From 684134dddb0d156adf1b7d43e84d119c293ea36f Mon Sep 17 00:00:00 2001 From: Willy Sudiarto Raharjo Date: Sun, 25 Jun 2017 15:58:26 +0700 Subject: [PATCH] sqg: Added manual page. Signed-off-by: Willy Sudiarto Raharjo --- src/usr/man/man8/sqg.8 | 90 ++++++++++++++++++++++ tools/ChangeLog-latest.txt | 3 +- tools/sqg8.html | 151 +++++++++++++++++++++++++++++++++++++ 3 files changed, 243 insertions(+), 1 deletion(-) create mode 100644 src/usr/man/man8/sqg.8 create mode 100644 tools/sqg8.html diff --git a/src/usr/man/man8/sqg.8 b/src/usr/man/man8/sqg.8 new file mode 100644 index 0000000..51260ff --- /dev/null +++ b/src/usr/man/man8/sqg.8 @@ -0,0 +1,90 @@ +.\"===================================================================== +.TH sqg 8 "xxxDATExxx" sbopkg-xxxVERSIONxxx "" +.\"===================================================================== +.SH NAME +sqg \- SBo Queue Generator +.\"===================================================================== +.SH SYNOPSIS +.B sqg +.RI [ options ] +.\"===================================================================== +.SH DESCRIPTION +.B sqg +is a command-line script to generate queue file(s) to be used by +sbopkg in order to list all dependencies for a certain package. +.\"===================================================================== +.SH OPTIONS +.\"--------------------------------------------------------------------- +.TP 5 +.BI \-p " PACKAGE(s)" +Creates queuefile(s) for individual package(s). +Multiple packages can be passed with quotes. +.IP +.B +Package names are case-sensitive. +.IP +For example: +.RS +.IP +.nf +\fC# sqg -p "pkg1 pkg2".\fP +.fi +.RE +.IP +will generate queue file for +.IR pkg1 +and +.IR pkg2 . +.TP +.BI \-a +Builds queuefiles for all packages. +.TP +.BI \-j " " +Number of concurrent queuefile generation processes. +This could heavily raise disk I/O so use with care. +.IP +.B +Requires: GNU parallel (auto-detected) +.IP +Default: 1 +.TP +.BI \-o " " + User-defined queue output filename (without .sqf extension). +This could be useful to create custom queue file. +Multiple packages can be passed with quotes. +.IP +For example: +.RS +.IP +.nf +\fC# sqg -p "qt5-webkit sshblock letsencrypt" -o myqueue\fP +.fi +.RE +.IP +will create a new queue called +.B myqueue +containing all dependencies for qt5-webkit, sshblock, and letsencrypt. +.IP +You can then run +.B +sbopkg -i myqueue +to have them installed (make sure to pick Queue). +.\"===================================================================== +.SH AUTHORS +Willy Sudiarto Raharjo + + +Chess Griffin + +.PP +Mauro Giachero + +.PP +slakmagik + +.\"===================================================================== +.\" Make the release process handle a DOCDIR here? But the files from +.\" the official tarball go here. +.SH SEE ALSO +.BR sbopkg.conf (5), +.IR /usr/doc/sbopkg-xxxVERSIONxxx/README-queuefiles diff --git a/tools/ChangeLog-latest.txt b/tools/ChangeLog-latest.txt index 9b63855..bbc4049 100644 --- a/tools/ChangeLog-latest.txt +++ b/tools/ChangeLog-latest.txt @@ -1,6 +1,6 @@ SBOPKG NEWS -sbopkg-dev (2017-06-18 01:40:00 UTC) +sbopkg-dev (2017-06-25 08:58:00 UTC) FEATURES * sqg: Parallelize building of single and all packages by option -j. Requires GNU Parallel. @@ -14,6 +14,7 @@ sbopkg-dev (2017-06-18 01:40:00 UTC) You can then run sbopkg -i to install all packages+deps. Feature Request by Jeremy/bassmadrigal (Fixed #13). Implement contributions from Marcel Saegebarth. + * sqg: Added manual page for sqg. MODIFICATIONS * bash-completion: Complete -i and -b when git repo is used diff --git a/tools/sqg8.html b/tools/sqg8.html new file mode 100644 index 0000000..1e2a0eb --- /dev/null +++ b/tools/sqg8.html @@ -0,0 +1,151 @@ +Content-type: text/html + +Manpage of sqg + +

sqg

+Section: (8)
Updated: June 2017
Index +Return to Main Contents
+ + +  +

NAME

+ +sqg - SBo Queue Generator + +  +

SYNOPSIS

+ +sqg + +[options] + + +  +

DESCRIPTION

+ +sqg + +is a command-line script to generate queue file(s) to be used by +sbopkg in order to list all dependencies for a certain package. + +  +

OPTIONS

+ + +
+
-p PACKAGE(s) + +
+Creates queuefile(s) for individual package(s). +Multiple packages can be passed with quotes. +
+Package names are case-sensitive. + +
+For example: +
+
+
+
+# sqg -p "pkg1 pkg2".
+
+ +
+
+ +
+will generate queue file for +pkg1 + +and +pkg2. + +
-a + +
+Builds queuefiles for all packages. +
-j <num> + +
+Number of concurrent queuefile generation processes. +This could heavily raise disk I/O so use with care. +
+Requires: GNU parallel (auto-detected) + +
+Default: 1 +
-o <output> + +
+
 User-defined queue output filename (without .sqf extension). +This could be useful to create custom queue file. +Multiple packages can be passed with quotes. +
+For example: +
+
+
+
+# sqg -p "qt5-webkit sshblock letsencrypt" -o myqueue
+
+ +
+
+ +
+will create a new queue called +myqueue + +containing all dependencies for qt5-webkit, sshblock, and letsencrypt. +
+You can then run +sbopkg -i myqueue + +to have them installed (make sure to pick Queue). + +
+  +

AUTHORS

+ +Willy Sudiarto Raharjo +<willysr@sbopkg.org> +

+Chess Griffin +<chess@chessgriffin.com> +

+ +Mauro Giachero +<mauro.giachero@gmail.com> +

+ +slakmagik +<slakmagik@gmail.com> + + + +  +

SEE ALSO

+ +sbopkg.conf(5), + +/usr/doc/sbopkg-0.38.2/README-queuefiles + +

+ +

+ 

Index

+
+
NAME
+
SYNOPSIS
+
DESCRIPTION
+
OPTIONS
+
AUTHORS
+
SEE ALSO
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 08:55:23 GMT, June 25, 2017 + +