diff options
Diffstat (limited to 'lib/stdlib/doc/src/zip.xml')
| -rw-r--r-- | lib/stdlib/doc/src/zip.xml | 68 |
1 files changed, 35 insertions, 33 deletions
diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index 306ad27997..a056621ca1 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -47,42 +47,42 @@ <list type="bulleted"> <item> <p>To create zip archives, use function - <seealso marker="#zip/2"><c>zip/2</c></seealso> or - <seealso marker="#zip/2"><c>zip/3</c></seealso>. They are + <seemfa marker="#zip/2"><c>zip/2</c></seemfa> or + <seemfa marker="#zip/2"><c>zip/3</c></seemfa>. They are also available as <c>create/2,3</c>, to resemble the - <seealso marker="erl_tar"><c>erl_tar</c></seealso> module.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl> module.</p> </item> <item> <p>To extract files from a zip archive, use function - <seealso marker="#unzip/1"><c>unzip/1</c></seealso> or - <seealso marker="#unzip/2"><c>unzip/2</c></seealso>. They are + <seemfa marker="#unzip/1"><c>unzip/1</c></seemfa> or + <seemfa marker="#unzip/2"><c>unzip/2</c></seemfa>. They are also available as <c>extract/1,2</c>, to resemble the - <seealso marker="erl_tar"><c>erl_tar</c></seealso> module.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl> module.</p> </item> <item> <p>To fold a function over all files in a zip archive, use function - <seealso marker="#foldl/3"><c>foldl/3</c></seealso>.</p> + <seemfa marker="#foldl/3"><c>foldl/3</c></seemfa>.</p> </item> <item> <p>To return a list of the files in a zip archive, use function - <seealso marker="#list_dir/1"><c>list_dir/1</c></seealso> or - <seealso marker="#list_dir/2"><c>list_dir/2</c></seealso>. They are + <seemfa marker="#list_dir/1"><c>list_dir/1</c></seemfa> or + <seemfa marker="#list_dir/2"><c>list_dir/2</c></seemfa>. They are also available as <c>table/1,2</c>, to resemble the - <seealso marker="erl_tar"><c>erl_tar</c></seealso> module.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl> module.</p> </item> <item> <p>To print a list of files to the Erlang shell, use function - <seealso marker="#t/1"><c>t/1</c></seealso> or - <seealso marker="#tt/1"><c>tt/1</c></seealso>.</p> + <seemfa marker="#t/1"><c>t/1</c></seemfa> or + <seemfa marker="#tt/1"><c>tt/1</c></seemfa>.</p> </item> <item> <p>Sometimes it is desirable to open a zip archive, and to unzip files from it file by file, without having to reopen the archive. This can be done by functions - <seealso marker="#zip_open/1"><c>zip_open/1,2</c></seealso>, - <seealso marker="#zip_get/1"><c>zip_get/1,2</c></seealso>, - <seealso marker="#zip_list_dir/1"><c>zip_list_dir/1</c></seealso>, and - <seealso marker="#zip_close/1"><c>zip_close/1</c></seealso>.</p> + <seemfa marker="#zip_open/1"><c>zip_open/1,2</c></seemfa>, + <seemfa marker="#zip_get/1"><c>zip_get/1,2</c></seemfa>, + <seemfa marker="#zip_list_dir/1"><c>zip_list_dir/1</c></seemfa>, and + <seemfa marker="#zip_close/1"><c>zip_close/1</c></seemfa>.</p> </item> </list> </description> @@ -136,8 +136,8 @@ <tag><c>info</c></tag> <item> <p>File information as in - <seealso marker="kernel:file#read_file_info/1"> - <c>file:read_file_info/1</c></seealso> + <seemfa marker="kernel:file#read_file_info/1"> + <c>file:read_file_info/1</c></seemfa> in Kernel</p> </item> <tag><c>comment</c></tag> @@ -165,15 +165,15 @@ <datatype> <name name="create_option"/> <desc> - <p>These options are described in <seealso marker="#zip_options"> - <c>create/3</c></seealso>.</p> + <p>These options are described in <seeerl marker="#zip_options"> + <c>create/3</c></seeerl>.</p> </desc> </datatype> <datatype> <name name="handle"/> <desc> <p>As returned by - <seealso marker="#zip_open/2"><c>zip_open/2</c></seealso>.</p> + <seemfa marker="#zip_open/2"><c>zip_open/2</c></seemfa>.</p> </desc> </datatype> </datatypes> @@ -245,7 +245,7 @@ <p><c>list_dir/2</c> provides options.</p> <p><c>table/1</c> and <c>table/2</c> are provided as synonyms to resemble the - <seealso marker="erl_tar"><c>erl_tar</c></seealso> module.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl> module.</p> <p>The result value is the tuple <c>{ok, List}</c>, where <c>List</c> contains the zip archive comment as the first element.</p> <p>One option is available:</p> @@ -293,7 +293,7 @@ <p><c>unzip/2</c> provides options to extract some files, and more.</p> <p><c>extract/1</c> and <c>extract/2</c> are provided as synonyms to resemble module - <seealso marker="erl_tar"><c>erl_tar</c></seealso>.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl>.</p> <p>If argument <c><anno>Archive</anno></c> is specified as a binary, the contents of the binary is assumed to be a zip archive, otherwise a filename.</p> @@ -344,8 +344,8 @@ <p>Uses the specified directory as current directory. It is prepended to filenames when extracting them from the zip archive. (Acting like - <seealso marker="kernel:file#set_cwd/1"> - <c>file:set_cwd/1</c></seealso> in Kernel, + <seemfa marker="kernel:file#set_cwd/1"> + <c>file:set_cwd/1</c></seemfa> in Kernel, but without changing the global <c>cwd</c> property.)</p> </item> </taglist> @@ -358,12 +358,14 @@ <name name="create" arity="2" since=""/> <name name="create" arity="3" since=""/> <fsummary>Create a zip archive with options.</fsummary> + <type name="create_option"/> + <type name="extension_spec"/> <desc> <p>Creates a zip archive containing the files specified in <c><anno>FileList</anno></c>.</p> <p><c>create/2</c> and <c>create/3</c> are provided as synonyms to resemble module - <seealso marker="erl_tar"><c>erl_tar</c></seealso>.</p> + <seeerl marker="erl_tar"><c>erl_tar</c></seeerl>.</p> <p><c><anno>FileList</anno></c> is a list of files, with paths relative to the current directory, which are stored with this path in the archive. Files can also be specified with data in binaries @@ -408,7 +410,7 @@ <p>The output is not to a file, but instead as a tuple <c>{<anno>FileName</anno>, binary()}</c>. The binary is a full zip archive with header and can be extracted with, for example, - <seealso marker="#unzip/2"><c>unzip/2</c></seealso>.</p> + <seemfa marker="#unzip/2"><c>unzip/2</c></seemfa>.</p> </item> <tag><c>{comment, <anno>Comment</anno>}</c></tag> <item> @@ -419,8 +421,8 @@ <p>Uses the specified directory as current work directory (<c>cwd</c>). This is prepended to filenames when adding them, although not in the zip archive (acting like - <seealso marker="kernel:file#set_cwd/1"> - <c>file:set_cwd/1</c></seealso> in Kernel, but without + <seemfa marker="kernel:file#set_cwd/1"> + <c>file:set_cwd/1</c></seemfa> in Kernel, but without changing the global <c>cwd</c> property.).</p> </item> <tag><c>{compress, <anno>What</anno>}</c></tag> @@ -485,7 +487,7 @@ <fsummary>Close an open archive.</fsummary> <desc> <p>Closes a zip archive, previously opened with - <seealso marker="#zip_open/1"><c>zip_open/1,2</c></seealso>. + <seemfa marker="#zip_open/1"><c>zip_open/1,2</c></seemfa>. All resources are closed, and the handle is not to be used after closing.</p> </desc> @@ -499,7 +501,7 @@ <p>Extracts one or all files from an open archive.</p> <p>The files are unzipped to memory or to file, depending on the options specified to function - <seealso marker="#zip_open/1"><c>zip_open/1,2</c></seealso> + <seemfa marker="#zip_open/1"><c>zip_open/1,2</c></seemfa> when opening the archive.</p> </desc> </func> @@ -521,9 +523,9 @@ <p>Opens a zip archive, and reads and saves its directory. This means that later reading files from the archive is faster than unzipping files one at a time with - <seealso marker="#unzip/1"><c>unzip/1,2</c></seealso>.</p> + <seemfa marker="#unzip/1"><c>unzip/1,2</c></seemfa>.</p> <p>The archive must be closed with - <seealso marker="#zip_close/1"><c>zip_close/1</c></seealso>.</p> + <seemfa marker="#zip_close/1"><c>zip_close/1</c></seemfa>.</p> <p>The <c><anno>ZipHandle</anno></c> is closed if the process that originally opened the archive dies.</p> </desc> |