From: Michael Schroeder <mls@suse.de>
Date: Tue, 15 Apr 2025 11:11:30 +0000 (+0200)
Subject: Add apk2solv man page
X-Git-Tag: 0.7.33~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=22964c8a912a143379a51a647f733d51ed6fdf60;p=thirdparty%2Flibsolv.git

Add apk2solv man page
---

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index ed38274e..a3b0a0ee 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -42,6 +42,10 @@ IF (ENABLE_APPDATA)
 SET (libsolv_MANPAGES1 ${libsolv_MANPAGES1} appdata2solv.1)
 ENDIF (ENABLE_APPDATA)
 
+IF (ENABLE_APK)
+SET (libsolv_MANPAGES1 ${libsolv_MANPAGES1} apk2solv.1)
+ENDIF (ENABLE_APK)
+
 # prepend gen directory
 STRING(REGEX REPLACE "([^;]+)" "gen/\\1" libsolv_MANPAGES1 "${libsolv_MANPAGES1}")
 STRING(REGEX REPLACE "([^;]+)" "gen/\\1" libsolv_MANPAGES3 "${libsolv_MANPAGES3}")
diff --git a/doc/Makefile.gen b/doc/Makefile.gen
index e9f1b69f..ee4b9318 100644
--- a/doc/Makefile.gen
+++ b/doc/Makefile.gen
@@ -7,7 +7,7 @@ man3:	libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libso
 
 man1:	mergesolv.1 dumpsolv.1 installcheck.1 testsolv.1 rpmdb2solv.1 rpms2solv.1 \
 	rpmmd2solv.1 repomdxml2solv.1 updateinfoxml2solv.1 deltainfoxml2solv.1 \
-	helix2solv.1 susetags2solv.1 comps2solv.1 deb2solv.1 mdk2solv.1 \
+	helix2solv.1 susetags2solv.1 comps2solv.1 deb2solv.1 mdk2solv.1 apk2solv.1 \
 	archpkgs2solv.1 archrepo2solv.1 appdata2solv.1 repo2solv.1 solv.1
 
 html: libsolv.html libsolv-bindings.html libsolv-constantids.html libsolv-history.html libsolv-pool.html
diff --git a/doc/apk2solv.txt b/doc/apk2solv.txt
new file mode 100644
index 00000000..6dac81eb
--- /dev/null
+++ b/doc/apk2solv.txt
@@ -0,0 +1,52 @@
+apk2solv(1)
+============
+:man manual: LIBSOLV
+:man source: libsolv
+
+
+Name
+----
+apk2solv - convert one or more apk package files into a solv file
+
+Synopsis
+--------
+*apk2solv* ['OPTIONS'] 'PKG1.apk' ...
+
+Description
+-----------
+The apk2solv tool converts the meta data from one or more
+Apk packages into the solv file written to standard output.
+
+*-m* 'MANIFESTFILE'::
+Read the rpm file names from the specified 'MANIFESTFILE'. You can
+use *-* to read the manifest from standard input.
+
+*-0*::
+Use a null byte as line terminator for manifest files instead of
+a newline. This is useful if the file names can contain newlines.
+See also the *-print0* option in *find*.
+
+*-C*::
+Add the apk checksum to the meta data.
+
+*-r*::
+Enable repository metadata mode. The specified file is not an
+apk package, but a file containing repository metadata (e.g.
+'APKINDEX.tar.gz').
+
+*-l*::
+Enable local database mode. The specified file is not an
+apk package, but a database file containing information about
+the installed packages (e.g. '/lib/apk/db/installed').
+
+See Also
+--------
+apk(8)
+
+Author
+------
+Michael Schroeder <mls@suse.de>
+
+////
+vim: syntax=asciidoc
+////
diff --git a/doc/gen/apk2solv.1 b/doc/gen/apk2solv.1
new file mode 100644
index 00000000..d2a08c7d
--- /dev/null
+++ b/doc/gen/apk2solv.1
@@ -0,0 +1,76 @@
+'\" t
+.\"     Title: apk2solv
+.\"    Author: [see the "Author" section]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 04/15/2025
+.\"    Manual: LIBSOLV
+.\"    Source: libsolv
+.\"  Language: English
+.\"
+.TH "APK2SOLV" "1" "04/15/2025" "libsolv" "LIBSOLV"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+apk2solv \- convert one or more apk package files into a solv file
+.SH "SYNOPSIS"
+.sp
+\fBapk2solv\fR [\fIOPTIONS\fR] \fIPKG1\&.apk\fR \&...
+.SH "DESCRIPTION"
+.sp
+The apk2solv tool converts the meta data from one or more Apk packages into the solv file written to standard output\&.
+.PP
+\fB\-m\fR \fIMANIFESTFILE\fR
+.RS 4
+Read the rpm file names from the specified
+\fIMANIFESTFILE\fR\&. You can use
+\fB\-\fR
+to read the manifest from standard input\&.
+.RE
+.PP
+\fB\-0\fR
+.RS 4
+Use a null byte as line terminator for manifest files instead of a newline\&. This is useful if the file names can contain newlines\&. See also the
+\fB\-print0\fR
+option in
+\fBfind\fR\&.
+.RE
+.PP
+\fB\-C\fR
+.RS 4
+Add the apk checksum to the meta data\&.
+.RE
+.PP
+\fB\-r\fR
+.RS 4
+Enable repository metadata mode\&. The specified file is not an apk package, but a file containing repository metadata (e\&.g\&.
+\fIAPKINDEX\&.tar\&.gz\fR)\&.
+.RE
+.PP
+\fB\-l\fR
+.RS 4
+Enable local database mode\&. The specified file is not an apk package, but a database file containing information about the installed packages (e\&.g\&.
+\fI/lib/apk/db/installed\fR)\&.
+.RE
+.SH "SEE ALSO"
+.sp
+apk(8)
+.SH "AUTHOR"
+.sp
+Michael Schroeder <mls@suse\&.de>