doc/manpages/man1/apple_dump.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="apple_dump.1">
   3   <refmeta>
   4     <refentrytitle>apple_dump</refentrytitle>
   5
   6     <manvolnum>1</manvolnum>
   7
   8     <refmiscinfo class="date">16 Jul 2012</refmiscinfo>
   9
  10     <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="name">
  14     <refname>apple_dump</refname>
  15
  16     <refpurpose>Dump AppleSingle/AppleDouble format data</refpurpose>
  17   </refnamediv>
  18
  19   <refsynopsisdiv id="synopsis">
  20     <cmdsynopsis>
  21       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  22
  23       <arg choice="opt"><arg choice="plain">-a</arg></arg>
  24
  25       <group choice="opt">
  26         <arg choice="plain"><replaceable>FILE</replaceable></arg>
  27         <arg choice="plain"><replaceable>DIR</replaceable></arg>
  28       </group>
  29
  30       <sbr />
  31
  32       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  33
  34       <arg choice="plain">-e</arg>
  35
  36       <group choice="plain">
  37         <arg choice="plain"><replaceable>FILE</replaceable></arg>
  38         <arg choice="plain"><replaceable>DIR</replaceable></arg>
  39       </group>
  40
  41       <sbr />
  42
  43       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  44
  45       <arg choice="plain">-f</arg>
  46
  47       <arg choice="opt"><replaceable>FILE</replaceable></arg>
  48
  49       <sbr />
  50
  51       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  52
  53       <arg choice="plain">-d</arg>
  54
  55       <arg choice="opt"><replaceable>FILE</replaceable></arg>
  56
  57       <sbr />
  58
  59       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  60
  61       <group choice="plain">
  62         <arg choice="plain">-h</arg>
  63         <arg choice="plain">-help</arg>
  64         <arg choice="plain">--help</arg>
  65       </group>
  66
  67       <sbr />
  68
  69       <command>apple_dump<indexterm><primary>apple_dump</primary></indexterm></command>
  70
  71       <group choice="plain">
  72         <arg choice="plain">-v</arg>
  73         <arg choice="plain">-version</arg>
  74         <arg choice="plain">--version</arg>
  75       </group>
  76
  77     </cmdsynopsis>
  78   </refsynopsisdiv>
  79
  80   <refsect1 id="description">
  81     <title>DESCRIPTION</title>
  82
  83     <para><command>apple_dump</command> is a perl script to dump
  84     AppleSingle/AppleDouble format data. </para>
  85     <para>This script can dump various AppleSingle/AppleDouble data created
  86     by mailer, archiver, Mac OS X, Netatalk and so on.</para>
  87     <para>With no <replaceable>FILE</replaceable>|<replaceable>DIR</replaceable>, or when <replaceable>FILE</replaceable>|<replaceable>DIR</replaceable> is -, read standard input.</para>
  88
  89   </refsect1>
  90
  91   <refsect1>
  92     <title>OPTIONS</title>
  93
  94     <variablelist remap="TP">
  95       <varlistentry>
  96         <term><option>-a</option> [<replaceable>FILE</replaceable>|<replaceable>DIR</replaceable>]</term>
  97
  98         <listitem>
  99           <para>This is default.
 100           Dump a AppleSingle/AppleDouble file for
 101           <replaceable>FILE</replaceable> or <replaceable>DIR</replaceable>
 102           automatically.
 103           If FILE is not AppleSingle/AppleDouble format,
 104           look for extended attribute,
 105           <replaceable>.AppleDouble/FILE</replaceable> and
 106           <replaceable>._FILE</replaceable>.
 107           If <replaceable>DIR</replaceable>, look for
 108           extended attribute,
 109           <replaceable>DIR/.AppleDouble/.Parent</replaceable> and
 110           <replaceable>._DIR</replaceable>.</para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term><option>-e</option> <replaceable>FILE</replaceable>|<replaceable>DIR</replaceable></term>
 116
 117         <listitem>
 118           <para>Dump extended attribute of<replaceable>FILE</replaceable> or <replaceable>DIR</replaceable>.</para>
 119         </listitem>
 120       </varlistentry>
 121
 122       <varlistentry>
 123         <term><option>-f</option> [<replaceable>FILE</replaceable>]</term>
 124
 125         <listitem>
 126           <para>Dump <replaceable>FILE</replaceable>. Assume FinderInfo to be FileInfo.</para>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term><option>-d</option> [<replaceable>FILE</replaceable>]</term>
 132
 133         <listitem>
 134           <para>Dump <replaceable>FILE</replaceable>. Assume FinderInfo to be DirInfo.</para>
 135         </listitem>
 136
 137       </varlistentry>
 138
 139       <varlistentry>
 140         <term><option>-h, -help, --help</option></term>
 141
 142         <listitem>
 143           <para>Display the help and exit</para>
 144         </listitem>
 145
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term><option>-v, -version, --version</option></term>
 150
 151         <listitem>
 152           <para>Show version and exit</para>
 153         </listitem>
 154
 155       </varlistentry>
 156
 157     </variablelist>
 158   </refsect1>
 159
 160   <refsect1>
 161     <title>NOTE</title>
 162
 163     <para>There is no way to detect whether FinderInfo is FileInfo or DirInfo.
 164     By default, apple_dump examines whether file or directory, a parent directory
 165     is .AppleDouble, filename is ._*, filename is .Parent, and so on.</para>
 166
 167     <para>If setting option -e, -f or -d,  assume FinderInfo and doesn't look
 168     for another file.</para>
 169
 170   </refsect1>
 171
 172   <refsect1 id="see_also">
 173     <title>SEE ALSO</title>
 174
 175     <para><citerefentry><refentrytitle>ad</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 176     <citerefentry><refentrytitle>getfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 177     <citerefentry><refentrytitle>attr</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 178     <citerefentry><refentrytitle>runat</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 179     <citerefentry><refentrytitle>getextattr</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 180     <citerefentry><refentrytitle>lsextattr</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
 181   </refsect1>
 182 </refentry>