diff options
author | Ned Ludd <solar@gentoo.org> | 2005-06-17 15:59:17 +0000 |
---|---|---|
committer | Ned Ludd <solar@gentoo.org> | 2005-06-17 15:59:17 +0000 |
commit | 6aec2a006510ff4a915819a1f27bfa39b38b7621 (patch) | |
tree | 22a7520de4729c5fa758c86fe34027ada5725b21 | |
parent | - insert non creative commit msg here. more touchups (diff) | |
download | portage-utils-0.1.1.tar.gz portage-utils-0.1.1.tar.bz2 portage-utils-0.1.1.zip |
- add some initial man pagesv0.1.1
-rwxr-xr-x | man/mkman.sh | 21 | ||||
-rw-r--r-- | man/q.1 | 69 | ||||
-rw-r--r-- | man/qcheck.1 | 25 | ||||
-rw-r--r-- | man/qdepends.1 | 37 | ||||
-rw-r--r-- | man/qfile.1 | 25 | ||||
-rw-r--r-- | man/qlist.1 | 22 | ||||
-rw-r--r-- | man/qsearch.1 | 33 | ||||
-rw-r--r-- | man/qsize.1 | 43 | ||||
-rw-r--r-- | man/quse.1 | 28 |
9 files changed, 273 insertions, 30 deletions
diff --git a/man/mkman.sh b/man/mkman.sh new file mode 100755 index 00000000..56b5df96 --- /dev/null +++ b/man/mkman.sh @@ -0,0 +1,21 @@ +#Usage: help2man [OPTION]... EXECUTABLE +# +# -n, --name=STRING description for the NAME paragraph +# -s, --section=SECTION section number for manual page (1, 6, 8) +# -m, --manual=TEXT name of manual (User Commands, ...) +# -S, --source=TEXT source of program (FSF, Debian, ...) +# -i, --include=FILE include material from `FILE' +# -I, --opt-include=FILE include material from `FILE' if it exists +# -o, --output=FILE send output to `FILE' +# -p, --info-page=TEXT name of Texinfo manual +# -N, --no-info suppress pointer to Texinfo manual +# --help print this help, then exit +# --version print version number, then exit + +APPLETS=$(../q | grep ^" - q"| awk '{print $2}') + +for applet in $APPLETS; do + help2man -N -S "Gentoo Foundation" -m ${applet} -s 1 -o ${applet}.1 "../q $applet" + sed -i -e s/'PORTAGE-UTILS-CVS:'/${applet}/g ${applet}.1 -e s/'portage-utils-cvs:'/${applet}/g ${applet}.1 + head -n $(($(cat ${applet}.1 | wc -l)-1)) ${applet}.1 > ${applet}.1~ && mv ${applet}.1~ ${applet}.1 +done @@ -1,25 +1,43 @@ -.TH q "1" "Jun 2005" "Gentoo" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH q "1" "June 2005" "Gentoo Foundation" "q" .SH NAME -q \- manual page for q, qfile, quse, qsearch, qlist +q \- manual page for q main.c compiled Jun 17 2005 .SH SYNOPSIS -.B -\fIq\fR \fR<function> [arguments]\fR -.TP -or: \fB\<function> [arguments]\fR +.B q +\fI<applet> \fR[\fIarguments\fR]... .SH DESCRIPTION -* Dump portage info on stuff -.SH FUNCTIONS -\fB\q\fR, \fB\<function> <args>\fR - - qfile <filename> : list all pkgs owning files - - qlist <pkgname> : list files owned by pkgname - - qsearch <regex> : search pkgname/desc - - quse <useflag> : find pkgs using useflag - - qsize <pkgname> : calculate size usage - - qcheck <pkgname> : verify mtimes/digests - - qdepends <pkgname> : show dependency info -.SH "COMMON OPTIONS" -.TP -\fB-C\fR, \fB\-\-nocolor\fR +.SS "Currently defined applets:" +.TP +- q <applet> <args> +: virtual applet +.TP +- qfile <filename> +: list all pkgs owning files +.TP +- qlist <pkgname> +: list files owned by pkgname +.TP +- qsearch <regex> +: search pkgname/desc +.TP +- quse <useflag> +: find pkgs using useflag +.TP +- qsize <pkgname> +: calculate size usage +.TP +- qcheck <pkgname> +: verify mtimes/digests +.TP +- qdepends <pkgname> +: show dependency info +.PP +Options: \fB\-[iChV]\fR +.TP +\fB\-i\fR, \fB\-\-install\fR +* Install symlinks for applets +.TP +\fB\-C\fR, \fB\-\-nocolor\fR * Don't output color .TP \fB\-h\fR, \fB\-\-help\fR @@ -27,14 +45,5 @@ or: \fB\<function> [arguments]\fR .TP \fB\-V\fR, \fB\-\-version\fR * Print version and exit -.SH "AUTHORS" -.nf -Ned Ludd <solar@gentoo.org> -Mike Frysinger <vapier@gentoo.org> -.fi -.SH "REPORTING BUGS" -Please report bugs via http://bugs.gentoo.org/ -.SH "SEE ALSO" -.BR portage (5) -.SH "CVS HEADER" -$Header: /var/cvsroot/gentoo-projects/portage-utils/man/q.1,v 1.2 2005/06/16 23:52:20 vapier Exp $ +.PP +$Id: q.1,v 1.3 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qcheck.1 b/man/qcheck.1 new file mode 100644 index 00000000..57376c1e --- /dev/null +++ b/man/qcheck.1 @@ -0,0 +1,25 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qcheck "1" "June 2005" "Gentoo Foundation" "qcheck" +.SH NAME +qcheck \- manual page for qcheck main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qcheck +\fI<pkgname>\fR +.SH DESCRIPTION +* qcheck: verify mtimes/digests +.PP +Options: \fB\-[aChV]\fR +.TP +\fB\-a\fR, \fB\-\-all\fR +* List all packages +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qcheck.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qdepends.1 b/man/qdepends.1 new file mode 100644 index 00000000..f10d7a49 --- /dev/null +++ b/man/qdepends.1 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qdepends "1" "June 2005" "Gentoo Foundation" "qdepends" +.SH NAME +qdepends \- manual page for qdepends main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qdepends +\fI<pkgname>\fR +.SH DESCRIPTION +* qdepends: show dependency info +.PP +Options: \fB\-[drpacChV]\fR +.TP +\fB\-d\fR, \fB\-\-depend\fR +* Show DEPEND info (default) +.TP +\fB\-r\fR, \fB\-\-rdepend\fR +* Show RDEPEND info +.TP +\fB\-p\fR, \fB\-\-pdepend\fR +* Show PDEPEND info +.TP +\fB\-c\fR, \fB\-\-cdepend\fR +* Show CDEPEND info +.TP +\fB\-a\fR, \fB\-\-all\fR +* Show all DEPEND info +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qdepends.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qfile.1 b/man/qfile.1 new file mode 100644 index 00000000..e28bd7f5 --- /dev/null +++ b/man/qfile.1 @@ -0,0 +1,25 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qfile "1" "June 2005" "Gentoo Foundation" "qfile" +.SH NAME +qfile \- manual page for qfile main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qfile +\fI<filename>\fR +.SH DESCRIPTION +* qfile: list all pkgs owning files +.PP +Options: \fB\-[eChV]\fR +.TP +\fB\-e\fR, \fB\-\-exact\fR +* Exact match +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qfile.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qlist.1 b/man/qlist.1 new file mode 100644 index 00000000..4b4fb0e4 --- /dev/null +++ b/man/qlist.1 @@ -0,0 +1,22 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qlist "1" "June 2005" "Gentoo Foundation" "qlist" +.SH NAME +qlist \- manual page for qlist main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qlist +\fI<pkgname>\fR +.SH DESCRIPTION +* qlist: list files owned by pkgname +.PP +Options: \fB\-[ChV]\fR +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qlist.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qsearch.1 b/man/qsearch.1 new file mode 100644 index 00000000..7ded12e8 --- /dev/null +++ b/man/qsearch.1 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qsearch "1" "June 2005" "Gentoo Foundation" "qsearch" +.SH NAME +qsearch \- manual page for qsearch main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qsearch +\fI<regex>\fR +.SH DESCRIPTION +* qsearch: search pkgname/desc +.PP +Options: \fB\-[acsSChV]\fR +.TP +\fB\-a\fR, \fB\-\-all\fR +* List the descriptions of every package in the cache +.TP +\fB\-c\fR, \fB\-\-cache\fR +* Use the portage cache +.TP +\fB\-s\fR, \fB\-\-search\fR +* Regex search package names +.HP +\fB\-S\fR, \fB\-\-searchdesc\fR <arg> * Regex search package descriptions +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qsearch.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/qsize.1 b/man/qsize.1 new file mode 100644 index 00000000..b20a7723 --- /dev/null +++ b/man/qsize.1 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH qsize "1" "June 2005" "Gentoo Foundation" "qsize" +.SH NAME +qsize \- manual page for qsize main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B qsize +\fI<pkgname>\fR +.SH DESCRIPTION +* qsize: calculate size usage +.PP +Options: \fB\-[fasSmkbChV]\fR +.TP +\fB\-f\fR, \fB\-\-filesystem\fR +* Show size used on disk +.TP +\fB\-a\fR, \fB\-\-all\fR +* Size all installed packages +.TP +\fB\-s\fR, \fB\-\-sum\fR +* Include a summary +.TP +\fB\-S\fR, \fB\-\-sum\-only\fR +* Show just the summary +.TP +\fB\-m\fR, \fB\-\-megabytes\fR +* Display size in megabytes +.TP +\fB\-k\fR, \fB\-\-kilobytes\fR +* Display size in kilobytes +.TP +\fB\-b\fR, \fB\-\-bytes\fR +* Display size in bytes +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: qsize.1,v 1.1 2005/06/17 15:59:17 solar Exp $ diff --git a/man/quse.1 b/man/quse.1 new file mode 100644 index 00000000..416364ee --- /dev/null +++ b/man/quse.1 @@ -0,0 +1,28 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29. +.TH quse "1" "June 2005" "Gentoo Foundation" "quse" +.SH NAME +quse \- manual page for quse main.c compiled Jun 17 2005 +.SH SYNOPSIS +.B quse +\fI<useflag>\fR +.SH DESCRIPTION +* quse: find pkgs using useflag +.PP +Options: \fB\-[avChV]\fR +.TP +\fB\-a\fR, \fB\-\-all\fR +* List every package in the cache +.TP +\fB\-v\fR, \fB\-\-verbose\fR +* Show annoying things in IUSE +.TP +\fB\-C\fR, \fB\-\-nocolor\fR +* Don't output color +.TP +\fB\-h\fR, \fB\-\-help\fR +* Print this help and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +* Print version and exit +.PP +$Id: quse.1,v 1.1 2005/06/17 15:59:17 solar Exp $ |