Skip to content

Commit

Permalink
regen man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
0-wiz-0 committed Sep 19, 2024
1 parent 700e294 commit f1269f0
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 24 deletions.
10 changes: 8 additions & 2 deletions man/libzip.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions man/libzip.man
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated from an mdoc input file. Do not edit.
.\" libzip.mdoc -- general overview of available functions
.\" Copyright (C) 2005-2022 Dieter Baron and Thomas Klausner
.\" Copyright (C) 2005-2024 Dieter Baron and Thomas Klausner
.\"
.\" This file is part of libzip, a library to manipulate ZIP archives.
.\" The authors can be contacted at <[email protected]>
Expand Down Expand Up @@ -30,7 +30,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.TH "LIBZIP" "3" "December 5, 2022" "NiH" "Library Functions Manual"
.TH "LIBZIP" "3" "August 21, 2024" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -66,6 +66,10 @@ zip archive atomically.
.PP
Below there are two sections listing functions: one for how to read
from zip archives and one for how to create/modify them.
.SH "GENERAL NOTES"
Unless explicitly documented, functions should not be passed
\fRNULL\fR
pointers as arguments.
.SH "FILE NAMES"
.SS "Encoding"
Names of files in the host file system are expected in UTF-8 encoding.
Expand Down
9 changes: 8 additions & 1 deletion man/zip_file_add.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion man/zip_file_add.man
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.TH "ZIP_FILE_ADD" "3" "September 22, 2020" "NiH" "Library Functions Manual"
.TH "ZIP_FILE_ADD" "3" "March 18, 2024" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -116,6 +116,17 @@ after it was used successfully in a
or
\fBzip_file_replace\fR
call.
.PP
Please also note that when using
\fBzip_replace\fR,
the target file's extra field information will be deleted since this
usually is dependent on the file contents.
If you want to keep them, query them beforehand with
zip_file_extra_field_get(3)
and restore them after
\fBzip_replace\fR
with
zip_file_extra_field_set(3).
.SH "RETURN VALUES"
Upon successful completion,
\fBzip_file_add\fR()
Expand Down
13 changes: 5 additions & 8 deletions man/zip_source_win32handle.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 3 additions & 10 deletions man/zip_source_win32handle.man
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.TH "ZIP_SOURCE_WIN32HANDLE" "3" "December 18, 2017" "NiH" "Library Functions Manual"
.TH "ZIP_SOURCE_WIN32HANDLE" "3" "May 14, 2024" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -61,9 +61,7 @@ The functions
and
\fBzip_source_win32handle_create\fR()
create a zip source from a Windows file handle.
They open
\fIfname\fR
and read
They read
\fIlen\fR
bytes from offset
\fIstart\fR
Expand Down Expand Up @@ -96,19 +94,14 @@ and
fail if:
.TP 19n
[\fRZIP_ER_INVAL\fR]
\fIfname\fR,
\fIh\fR,
\fIstart\fR,
or
\fIlen\fR
are invalid.
.TP 19n
[\fRZIP_ER_MEMORY\fR]
Required memory could not be allocated.
.TP 19n
[\fRZIP_ER_OPEN\fR]
Opening
\fIfname\fR
failed.
.SH "SEE ALSO"
libzip(3),
zip_file_add(3),
Expand Down

0 comments on commit f1269f0

Please sign in to comment.