contrib/libarchive/libarchive/archive_entry_misc.3

   1 .\" Copyright (c) 2019 Martin Matuska
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd April 15, 2019
  26 .Dt ARCHIVE_ENTRY_MISC 3
  27 .Os
  28 .Sh NAME
  29 .Nm archive_entry_symlink_type ,
  30 .Nm archive_entry_set_symlink_type
  31 .Nd miscellaneous functions for manipulating properties of archive_entry
  32 .Sh LIBRARY
  33 Streaming Archive Library (libarchive, -larchive)
  34 .Sh SYNOPSIS
  35 .In archive_entry.h
  36 .Ft int
  37 .Fn archive_entry_symlink_type "struct archive_entry *a"
  38 .Ft void
  39 .Fn archive_entry_set_symlink_type "struct archive_entry *a" "int"
  40 .Sh DESCRIPTION
  41 The function
  42 .Fn archive_entry_symlink_type
  43 returns and the function
  44 .Fn archive_entry_set_symlink_type
  45 sets the type of the symbolic link stored in an archive entry.
  46 These functions
  47 have special meaning on operating systems that support multiple symbolic link
  48 types (e.g. Microsoft Windows).
  49 .Pp
  50 Supported values are:
  51 .Bl -tag -width "AE_SYMLINK_TYPE_DIRECTORY" -compact
  52 .It AE_SYMLINK_TYPE_UNDEFINED
  53 Symbolic link target type is not defined (default on unix systems)
  54 .It AE_SYMLINK_TYPE_FILE
  55 Symbolic link points to a file
  56 .It AE_SYMLINK_TYPE_DIRECTORY
  57 Symbolic link points to a directory
  58 .El
  59 .Sh SEE ALSO
  60 .Xr archive_entry 3 ,
  61 .Xr archive_entry_paths 3 ,
  62 .Xr archive_entry_stat 3 ,
  63 .Xr libarchive 3