libzip(3) [debian man page]

LIBZIP(3)						     Library Functions Manual							 LIBZIP(3)

NAME

       libzip - library for manipulating zip archives

LIBRARY

       libzip (-lzip)

SYNOPSIS

       #include <zip.h>

DESCRIPTION

       libzip is a library for reading, creating, and modifying zip archives.

       Below there are two sections listing functions: one for how to read from zip archives and one for how to create/modify them.

READING ZIP ARCHIVES

   open archive
       zip_open(3) zip_fdopen(3)

   find files
       zip_name_locate(3)

   read files
       zip_fopen(3) zip_fopen_encrypted(3) zip_fopen_index(3) zip_fopen_index_encrypted(3) zip_fread(3) zip_fclose(3)

   close archive
       zip_close(3)

   miscellaneous
       zip_stat(3)    zip_get_archive_comment(3)    zip_get_archive_flag(3)    zip_get_file_comment(3)	  zip_get_name(3)   zip_get_num_entries(3)
       zip_set_default_password(3)

CREATING
/MODIFYING ZIP ARCHIVES
   create/open archive
       zip_open(3)

   add/change files and directories
       zip_add(3)   zip_add_dir(3)   zip_replace(3)   zip_set_file_comment(3)	 zip_source_buffer(3)	 zip_source_file(3)    zip_source_filep(3)
       zip_source_function(3) zip_source_zip(3) zip_source_free(3)

   rename files
       zip_rename(3)

   delete files
       zip_delete(3)

   revert changes
       zip_unchange(3) zip_unchange_all(3) zip_unchange_archive(3)

   close archive
       zip_close(3)

   miscellaneous
       zip_set_archive_comment(3) zip_set_archive_flag(3)

ERROR HANDLING

       zip_error_to_str(3) zip_strerror(3) zip_file_strerror(3) zip_error_get(3) zip_error_get_sys_type(3) zip_errors(3)

AUTHORS

       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>

NiH								 February 14, 2011							 LIBZIP(3)

ZIP_FOPEN(3)						     Library Functions Manual						      ZIP_FOPEN(3)

NAME

       zip_fopen , - .Nm zip_fopen_index open file in zip archive for reading

LIBRARY

       libzip (-lzip)

SYNOPSIS

       #include <zip.h>

       struct zip_file * zip_fopen(struct zip *archive, const char *fname, int flags);

       struct zip_file * zip_fopen_index(struct zip *archive, zip_uint64_t index, int flags);

DESCRIPTION

       The zip_fopen function opens the file name fname in archive.  The flags argument specifies how the name lookup should be done, according to
       the values are described in zip_name_locate(3).	Also, the following values may be or'ed to it.

	      ZIP_FL_COMPRESSED  Read the compressed data.  Otherwise the data is uncompressed by zip_fread.

	      ZIP_FL_UNCHANGED	 Read the original data from the zip archive, ignoring any changes made to the file.

       The zip_fopen_index function opens the file at position index.

       If encrypted data is encountered, the functions call zip_fopen_encrypted(3) or zip_fopen_index_encrypted(3) respectively, using the default
       password set with zip_set_default_password(3).

RETURN VALUES

       Upon successful completion, a

       struct zip_file pointer is returned.  Otherwise, NULL is returned and the error code in archive is set to indicate the error.

ERRORS

	      [ZIP_ER_CHANGED]
		  The file data has been changed.

	      [ZIP_ER_COMPNOTSUPP]
		  The compression method used is not supported.

	      [ZIP_ER_ENCRNOTSUPP]
		  The encryption method used is not supported.

	      [ZIP_ER_MEMORY]
		  Required memory could not be allocated.

	      [ZIP_ER_READ]
		  A file read error occurred.

	      [ZIP_ER_SEEK]
		  A file seek error occurred.

	      [ZIP_ER_ZLIB]
		  Initializing the zlib stream failed.

       The function zip_fopen may also fail and set for any of the errors specified for the routine zip_name_locate(3).

       The function zip_fopen_index may also fail with ZIP_ER_INVAL if index is invalid.

SEE ALSO

       libzip(3), zip_fclose(3), zip_fread(3), zip_get_num_entries(3), zip_name_locate(3), zip_set_default_password(3)

AUTHORS

       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>

NiH								 February 14, 2011						      ZIP_FOPEN(3)