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 Jul 19, 2023
1 parent 8edaa90 commit dc7816b
Show file tree
Hide file tree
Showing 10 changed files with 129 additions and 38 deletions.
7 changes: 6 additions & 1 deletion man/zip_set_archive_flag.html

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

8 changes: 7 additions & 1 deletion man/zip_set_archive_flag.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_SET_ARCHIVE_FLAG" "3" "January 23, 2023" "NiH" "Library Functions Manual"
.TH "ZIP_SET_ARCHIVE_FLAG" "3" "July 19, 2023" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -63,6 +63,12 @@ Supported flags are:
If this flag is cleared, the archive file will be removed if the archive is empty.
If it is set, an empty archive will be created, which is not recommended by the zip specification.
.TP 20n
\fRZIP_AFL_RDONLY\fR
If this flag is set, no modification to the archive are allowed.
This flag can only be cleared if it was manually set with
\fBzip_set_archive_flag\fR,
not if the archive was opened read-only.
.TP 20n
\fRZIP_AFL_WANT_TORRENTZIP\fR
If this flag is set, the archive will be written in torrentzip format.
.SH "RETURN VALUES"
Expand Down
26 changes: 22 additions & 4 deletions man/zip_source_file.html

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

45 changes: 39 additions & 6 deletions man/zip_source_file.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_FILE" "3" "December 18, 2017" "NiH" "Library Functions Manual"
.TH "ZIP_SOURCE_FILE" "3" "June 30, 2023" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -68,11 +68,39 @@ and read
bytes from offset
\fIstart\fR
from it.
If
\fIlen\fR
is 0 or \-1, the whole file (starting from
\fIstart\fR)
is used.
.PP
When passing
\fRZIP_LENGTH_TO_END\fR
(or \-1, which is deprecated) as
\fIlen\fR,
\fBzip_source_file\fR
determines the file size when it is called and uses that as the
expected file size.
If the file size grows between creating and reading from the source,
the additional data is ignored.
If the file shrinks,
\fBlibzip\fR
treats it as an error
(\fRZIP_ER_DATA_LENGTH\fR).
.PP
When passing
\fRZIP_LENGTH_UNCHECKED\fR
as
\fIlen\fR,
\fBzip_source_file\fR
assumes the file's size is unknown.
Reading from the source returns as much data as is there at that time
(usually when calling
zip_close(3)).
.PP
\fBlibzip\fR
can do various optimizations if the size of a source is known when
it's created, so
\fRZIP_LENGTH_TO_END\fR
is preferrable.
If you deal with files that are likely to change while you are
processing them, you can use the less efficient
\fRZIP_LENGTH_UNCHECKED\fR.
.PP
If the file supports seek, the source can be used to open a zip archive from.
.PP
Expand Down Expand Up @@ -119,6 +147,11 @@ zip_source(3)
and
\fBzip_source_file_create\fR()
were added in libzip 1.0.
.PP
\fRZIP_LENGTH_TO_END\fR
and
\fRZIP_LENGTH_UNCHECKED\fR
were added in libzip 1.10.1.
.SH "AUTHORS"
Dieter Baron <\fI[email protected]\fR>
and
Expand Down
13 changes: 9 additions & 4 deletions man/zip_source_filep.html

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

17 changes: 11 additions & 6 deletions man/zip_source_filep.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_FILEP" "3" "December 18, 2017" "NiH" "Library Functions Manual"
.TH "ZIP_SOURCE_FILEP" "3" "June 30, 2023" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -67,11 +67,10 @@ bytes from offset
\fIstart\fR
from the open file stream
\fIfile\fR.
If
For a description of the
\fIlen\fR
is 0 or \-1, the whole file (starting from
\fIstart\fR)
is used.
argument, see
zip_source_file(3).
.PP
If the file stream supports seeking, the source can be used to open
a read-only zip archive from.
Expand Down Expand Up @@ -105,12 +104,18 @@ Required memory could not be allocated.
libzip(3),
zip_file_add(3),
zip_file_replace(3),
zip_source(3)
zip_source(3),
zip_source_file(3)
.SH "HISTORY"
\fBzip_source_filep\fR()
and
\fBzip_source_filep_create\fR()
were added in libzip 1.0.
.PP
\fRZIP_LENGTH_TO_END\fR
and
\fRZIP_LENGTH_UNCHECKED\fR
were added in libzip 1.10.1.
.SH "AUTHORS"
Dieter Baron <\fI[email protected]\fR>
and
Expand Down
10 changes: 7 additions & 3 deletions man/zip_source_win32a.html

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

15 changes: 10 additions & 5 deletions man/zip_source_win32a.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_WIN32A" "3" "December 18, 2017" "NiH" "Library Functions Manual"
.TH "ZIP_SOURCE_WIN32A" "3" "June 30, 2023" "NiH" "Library Functions Manual"
.nh
.if n .ad l
.SH "NAME"
Expand Down Expand Up @@ -68,11 +68,10 @@ and read
bytes from offset
\fIstart\fR
from it.
If
For a description of the
\fIlen\fR
is 0 or \-1, the whole file (starting from
\fIstart\fR)
is used.
argument, see
zip_source_file(3).
.PP
If the file supports seek, the source can be used to open a zip archive from.
.PP
Expand Down Expand Up @@ -114,13 +113,19 @@ libzip(3),
zip_file_add(3),
zip_file_replace(3),
zip_source(3),
zip_source_file(3),
zip_source_win32handle(3),
zip_source_win32w(3)
.SH "HISTORY"
\fBzip_source_win32a\fR()
and
\fBzip_source_win32a_create\fR()
were added in libzip 1.0.
.PP
\fRZIP_LENGTH_TO_END\fR
and
\fRZIP_LENGTH_UNCHECKED\fR
were added in libzip 1.10.1.
.SH "AUTHORS"
Dieter Baron <\fI[email protected]\fR>
and
Expand Down
11 changes: 8 additions & 3 deletions man/zip_source_win32w.html

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

Loading

0 comments on commit dc7816b

Please sign in to comment.