From a1764382c3f47adf50e9ec9cc84ad1658f3d38e4 Mon Sep 17 00:00:00 2001 From: Nathan Wagner Date: Fri, 15 Feb 2019 13:56:37 +0000 Subject: [PATCH] expand docs --- doc/zpm-addfile.8 | 27 ++++++++++++++++++ doc/zpm-init.8 | 25 ++++++++++++++++ doc/zpm-merge.8 | 73 +++++++++++++++++++++++++++++++++++++++++++++++ doc/zpm-shell.8 | 26 +++++++++++++++++ doc/zpm-soneed.8 | 55 +++++++++++++++++++++++++++++++++++ doc/zpm.8 | 33 ++++++++++----------- 6 files changed, 223 insertions(+), 16 deletions(-) create mode 100644 doc/zpm-addfile.8 create mode 100644 doc/zpm-init.8 create mode 100644 doc/zpm-merge.8 create mode 100644 doc/zpm-shell.8 create mode 100644 doc/zpm-soneed.8 diff --git a/doc/zpm-addfile.8 b/doc/zpm-addfile.8 new file mode 100644 index 0000000..f7a00c1 --- /dev/null +++ b/doc/zpm-addfile.8 @@ -0,0 +1,27 @@ +.TH zpm-addfile 8 2019-02-15 "ZPM 0.3" +.SH NAME +zpm-addfile \- add file contents to a zpm database +.SH SYNOPSIS +.B zpm addfile +.I pkgfile path ... +.SH DESCRIPTION +\fBzpm-addfile\fR +adds file contents to a zpm database. After successfully adding +file content, the hash of the content is printed to stdout, followed +by a newline. +.SH OPTIONS +None. +.SH EXAMPLES +.TP +.B zpm addfile $ZPMDB /etc/passwd +Add the /etc/passwd content to the local database. +.SH EXIT STATUS +0 on success non zero on failure +.SH FILES +/var/lib/zpm/local.db +.SH ENVIRONMENT +ZPMDB +.SH AUTHOR +Nathan Wagner +.SH SEE ALSO +.BR zpm (8) diff --git a/doc/zpm-init.8 b/doc/zpm-init.8 new file mode 100644 index 0000000..3d7ffbd --- /dev/null +++ b/doc/zpm-init.8 @@ -0,0 +1,25 @@ +.TH zpm-init 8 2019-02-14 "ZPM 0.3" +.SH NAME +zpm-init \- run init +.SH SYNOPSIS +.B zpm init +.I path +.SH DESCRIPTION +\fBzpm-init\fR +creates and initialized a new empty zpm database given by \fIpath\fR +.SH OPTIONS +None. +.SH EXAMPLES +.TP +zpm init foo-1.0-1.zpm +Creates a new zpm database. +.SH EXIT STATUS +0 on success non zero on failure +.SH FILES +/var/lib/zpm/local.db +.SH ENVIRONMENT +None. +.SH AUTHOR +Nathan Wagner +.SH SEE ALSO +.BR zpm (8) diff --git a/doc/zpm-merge.8 b/doc/zpm-merge.8 new file mode 100644 index 0000000..95da8ec --- /dev/null +++ b/doc/zpm-merge.8 @@ -0,0 +1,73 @@ +.TH zpm-merge 8 2019-02-14 "ZPM 0.6" +.SH NAME +zpm-merge \- copy packages from one database to another +.SH SYNOPSIS +.B zpm merge -f \fIpkgfile\fR +[ +.B \-vFSauonO +] +[ +.BI \-d target +] +[ +.BI \-s status +] +.RI [ package ...] +.SH DESCRIPTION +\fBzpm-merge\fR copies package information from one database +to another. By default, file contents are not copied, but scripts +are. All other metadata about the package is copied, and the status +is set to null. +.SH OPTIONS +.TP +\-f \fIpath\fR +specify the package file to find packages in, required +.TP +\-d \fIpath\fR +specify the target database, defaults to $ZPMDB +.TP +\-s \fIstatus\fR +set the status of the copied packages to \fIstatus\fR +.TP +\-v +increase the verbosity level by one, may be given multiple times +.B \-vFSauonO +.TP +\-F +Also copy the file content. +.TP +\-S +Do not copy script file content. +.TP +\-a +Merge all packages. +.TP +\-u +update +.TP +\-n +newer +.TP +\-o +older +.TP +\-O +One at a time mode. Each package will be copied in a single transaction, +and failure of one package to copy will not prevent other packages from +being copied. Without this option, all the packages are copied in a +single transaction so that either all are copied or none are. +.SH EXAMPLES +.TP +zpm merge -f foo-1.0.3-1.zpm +Merge the the most recent package found in the foo-1.0.3-1.zpm file +into the local database specified by $ZPMDB. +.SH EXIT STATUS +0 on success non zero on failure +.SH FILES +/var/lib/zpm/local.db +.SH ENVIRONMENT +ZPMDB +.SH AUTHOR +Nathan Wagner +.SH SEE ALSO +zpm(8) diff --git a/doc/zpm-shell.8 b/doc/zpm-shell.8 new file mode 100644 index 0000000..01caccc --- /dev/null +++ b/doc/zpm-shell.8 @@ -0,0 +1,26 @@ +.TH zpm-shell 8 2019-02-14 "ZPM 0.3" +.SH NAME +zpm-shell \- list files in a zpm package +.SH SYNOPSIS +.B zpm shell +.SH DESCRIPTION +\fBzpm-shell\fR is a custom build sqlite3 shell, with vercmp added +as a collation functions. It is indended for zpm scripting, rather +than general use as it lacks readline and history support. +.SH OPTIONS +Any options are passed through to the general sqlite3 shell. +.SH EXAMPLES +.TP +zpm shell $ZPMDB 'select package from packages' +Will run the given query against an sqlite3 database found in $ZPMDB +.SH EXIT STATUS +0 on success non zero on failure +.SH FILES +None. +.SH ENVIRONMENT +Same as sqlite3 +.SH AUTHOR +Nathan Wagner +.SH SEE ALSO +.BR zpm (8) +.BR sqlite3 (1) diff --git a/doc/zpm-soneed.8 b/doc/zpm-soneed.8 new file mode 100644 index 0000000..c22ab3e --- /dev/null +++ b/doc/zpm-soneed.8 @@ -0,0 +1,55 @@ +.TH zpm-soneed 8 2018-12-10 "ZPM 0.4" +.SH NAME +zpm-soneed \- list the library dependencies of an elf file +.SH SYNOPSIS +.B zpm soneed \fR[\fB-l\fR] \fIpath\fR +.SH DESCRIPTION +\fBzpm-soneed\fR prints to stdout the dynamic libraries needed +by a given elf file. It is not an error if no needed libraries +are found. +.SH OPTIONS +.TP +\-l +Don't follow symlinks. If the path is a symlink, this will cause the program +to exit with status 1. +.SH EXAMPLES +.PP +.nf +zpm-soneed /usr/bin/vim +.fi +.SH EXIT STATUS +.TP +0 +if the file had an soname +.TP +1 +file is not a regular file, or unable to stat, no file given, or other file error +.TP +2 +unable map file to read elf info +.TP +3 +file is not an elf file +.TP +4 +file is not an dynamic library or executable file +.TP +5 +unable to determine 64 or 32 bit elf file +.TP +6 +unable to determine endianness +.TP +7 +File has no dynamic section +.TP +9 +File has no dynamic table +.SH FILES +None +.SH ENVIRONMENT +None +.SH AUTHOR +Nathan Wagner +.SH SEE ALSO +zpm(8) diff --git a/doc/zpm.8 b/doc/zpm.8 index c62ed61..ae923db 100644 --- a/doc/zpm.8 +++ b/doc/zpm.8 @@ -101,25 +101,26 @@ requirements that implies. Where possible, programs have been statically linked with musl rather than glibc, since glibc doesn't actually support static linking. For the musl copyright see https://git.musl-libc.org/cgit/musl/tree/COPYRIGHT. .SH SEE ALSO +.BR zpm-addfile (8) .BR zpm-contents (8) -.BR zpm-list (8) -.BR zpm-update (8) -.BR zpm-repo (8) -.BR zpm-quote (8) -.BR zpm-hash (8) -.BR zpm-fetchurl (8) -.BR zpm-soname (8) -.BR zpm-soneed (8) .BR zpm-elftype (8) -.BR zpm-merge (8) -.BR zpm-shell (8) .BR zpm-extract (8) +.BR zpm-fetchurl (8) +.BR zpm-hash (8) .BR zpm-init (8) -.BR zpm-sign (8) -.BR zpm-verify (8) -.BR zpm-parse (8) -.BR zpm-test (8) -.BR zpm-stat (8) +.BR zpm-list (8) .BR zpm-log (8) -.BR zpm-rmpackage (8) +.BR zpm-merge (8) .BR zpm-packagehash (8) +.BR zpm-parse (8) +.BR zpm-quote (8) +.BR zpm-repo (8) +.BR zpm-rmpackage (8) +.BR zpm-shell (8) +.BR zpm-sign (8) +.BR zpm-soname (8) +.BR zpm-soneed (8) +.BR zpm-stat (8) +.BR zpm-test (8) +.BR zpm-update (8) +.BR zpm-verify (8) -- 2.40.0