doc/manpages/man1/ad.1.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="ad.1">
   3   <refmeta>
   4     <refentrytitle>ad</refentrytitle>
   5
   6     <manvolnum>1</manvolnum>
   7
   8     <refmiscinfo class="date">02 Sep 2011</refmiscinfo>
   9
  10     <refmiscinfo class="source">:NETATALK_VERSION:</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv>
  14     <refname>ad</refname>
  15
  16     <refpurpose>Netatalk compatible UNIX file utility suite.</refpurpose>
  17   </refnamediv>
  18
  19   <refsynopsisdiv>
  20     <cmdsynopsis>
  21       <command>ad</command>
  22
  23       <arg choice="req">ls | cp | mv | rm</arg>
  24
  25       <arg>...</arg>
  26     </cmdsynopsis>
  27
  28     <cmdsynopsis>
  29       <command>ad</command>
  30
  31       <arg choice="req">-v | --version</arg>
  32     </cmdsynopsis>
  33   </refsynopsisdiv>
  34
  35   <refsect1>
  36     <title>Description</title>
  37
  38     <para><command>ad</command> is a UNIX file utility suite with Netatalk
  39     compatibility. AppleDouble<indexterm>
  40         <primary>AppleDouble</primary>
  41       </indexterm> files in <filename>.AppleDouble</filename> directories and
  42     the CNID databases are updated as appropriate.</para>
  43   </refsect1>
  44
  45   <refsect1>
  46     <title>Available Commands</title>
  47
  48     <cmdsynopsis>
  49       <command>ad ls</command>
  50
  51       <arg>-dRl<arg>u</arg></arg>
  52
  53       <arg choice="req">file|dir <arg>...</arg></arg>
  54     </cmdsynopsis>
  55
  56     <para>List files and directories.</para>
  57
  58     <cmdsynopsis>
  59       <command>ad cp</command>
  60
  61       <arg choice="opt">-aipvf</arg>
  62
  63       <arg choice="req">src_file</arg>
  64
  65       <arg choice="req">dst_file</arg>
  66     </cmdsynopsis>
  67
  68     <cmdsynopsis>
  69       <command>ad cp -R</command>
  70
  71       <arg choice="opt">-aipvf</arg>
  72
  73       <arg choice="req">src_file|src_directory ...</arg>
  74
  75       <arg choice="req">dst_directory</arg>
  76     </cmdsynopsis>
  77
  78     <para>Copy files and directories.</para>
  79
  80     <cmdsynopsis>
  81       <command>ad mv</command>
  82
  83       <arg choice="opt">-finv</arg>
  84
  85       <arg choice="req">src_file</arg>
  86
  87       <arg choice="req">dst_file</arg>
  88     </cmdsynopsis>
  89
  90     <cmdsynopsis>
  91       <command>ad mv</command>
  92
  93       <arg choice="opt">-finv</arg>
  94
  95       <arg choice="req">src_file|src_directory ...</arg>
  96
  97       <arg choice="req">dst_directory</arg>
  98     </cmdsynopsis>
  99
 100     <para>Move files and directories.</para>
 101
 102     <cmdsynopsis>
 103       <command>ad rm</command>
 104
 105       <arg choice="opt">-Rv</arg>
 106
 107       <arg choice="req">file|directory</arg>
 108     </cmdsynopsis>
 109
 110     <cmdsynopsis>
 111       <command>ad -v|--version</command>
 112     </cmdsynopsis>
 113
 114     <para>Show version.</para>
 115   </refsect1>
 116
 117   <refsect1>
 118     <title>ad ls</title>
 119
 120     <para>List files and directories. Options:</para>
 121
 122     <variablelist>
 123       <varlistentry>
 124         <term>-d</term>
 125
 126         <listitem>
 127           <para>Directories are listed as plain files</para>
 128         </listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term>-R</term>
 133
 134         <listitem>
 135           <para>list subdirectories recursively</para>
 136         </listitem>
 137       </varlistentry>
 138
 139       <varlistentry>
 140         <term>-l</term>
 141
 142         <listitem>
 143           <para>Long output, list AFP info</para>
 144         </listitem>
 145       </varlistentry>
 146
 147       <varlistentry>
 148         <term>-u</term>
 149
 150         <listitem>
 151           <para>List UNIX info</para>
 152         </listitem>
 153       </varlistentry>
 154     </variablelist>
 155
 156     <para><emphasis>Long output description</emphasis></para>
 157
 158     <programlisting>&lt;unixinfo&gt; &lt;FinderFlags&gt; &lt;AFP Attributes&gt; &lt;Color&gt; &lt;Type&gt; &lt;Creator&gt; &lt;CNID from AppleDouble&gt; &lt;name&gt;
 159
 160 FinderFlags (valid for (f)iles and/or (d)irectories):
 161
 162   d = On Desktop                      (f/d)
 163   e = Hidden extension                (f/d)
 164   m = Shared (can run multiple times) (f)
 165   n = No INIT resources               (f)
 166   i = Inited                          (f/d)
 167   c = Custom icon                     (f/d)
 168   t = Stationery                      (f)
 169   s = Name locked                     (f/d)
 170   b = Bundle                          (f/d)
 171   v = Invisible                       (f/d)
 172   a = Alias file                      (f/d)
 173
 174 AFP Attributes:
 175
 176   y = System                          (f/d)
 177   w = No write                        (f)
 178   p = Needs backup                    (f/d)
 179   r = No rename                       (f/d)
 180   l = No delete                       (f/d)
 181   o = No copy                         (f)
 182
 183 Note: any letter appearing in uppercase means the flag is set but it's a directory for which the flag is not allowed.</programlisting>
 184   </refsect1>
 185
 186   <refsect1>
 187     <title>ad cp</title>
 188
 189     <para>Copy files and directories.</para>
 190
 191     <para>In the first synopsis form, the cp utility copies the contents of
 192     the source_file to the target_file. In the second synopsis form, the
 193     contents of each named source_file is copied to the destination
 194     target_directory. The names of the files themselves are not changed. If cp
 195     detects an attempt to copy a file to itself, the copy will fail.</para>
 196
 197     <para>Netatalk AFP volumes are detected by means of their ".AppleDesktop"
 198     directory which is located in their volume root. When a copy targeting an
 199     AFP volume is detected, its CNID database daemon is connected and all
 200     copies will also go through the CNID database. AppleDouble files are also
 201     copied and created as needed when the target is an AFP volume.</para>
 202
 203     <para>Options:</para>
 204
 205     <variablelist>
 206       <varlistentry>
 207         <term>-a</term>
 208
 209         <listitem>
 210           <para>Archive mode. Same as -Rp.</para>
 211         </listitem>
 212       </varlistentry>
 213
 214       <varlistentry>
 215         <term>-f</term>
 216
 217         <listitem>
 218           <para>For each existing destination pathname, remove it and create a
 219           new file, without prompting for confirmation regardless of its
 220           permis- sions. (The -f option overrides any previous -i or -n
 221           options.)</para>
 222         </listitem>
 223       </varlistentry>
 224
 225       <varlistentry>
 226         <term>-i</term>
 227
 228         <listitem>
 229           <para>Cause cp to write a prompt to the standard error output before
 230           copying a file that would overwrite an existing file. If the
 231           response from the standard input begins with the character 'y' or
 232           'Y', the file copy is attempted. (The -i option overrides any pre-
 233           vious -f or -n options.)</para>
 234         </listitem>
 235       </varlistentry>
 236
 237       <varlistentry>
 238         <term>-n</term>
 239
 240         <listitem>
 241           <para>Do not overwrite an existing file. (The -n option overrides
 242           any previous -f or -i options.)</para>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry>
 247         <term>-p</term>
 248
 249         <listitem>
 250           <para>Cause cp to preserve the following attributes of each source
 251           file in the copy: modification time, access time, file flags, file
 252           mode, user ID, and group ID, as allowed by permissions. If the user
 253           ID and group ID cannot be preserved, no error message is displayed
 254           and the exit value is not altered.</para>
 255         </listitem>
 256       </varlistentry>
 257
 258       <varlistentry>
 259         <term>-R</term>
 260
 261         <listitem>
 262           <para>If source_file designates a directory, cp copies the directory
 263           and the entire subtree connected at that point.If the source_file
 264           ends in a /, the contents of the directory are copied rather than
 265           the directory itself.</para>
 266         </listitem>
 267       </varlistentry>
 268
 269       <varlistentry>
 270         <term>-v</term>
 271
 272         <listitem>
 273           <para>Cause cp to be verbose, showing files as they are
 274           copied.</para>
 275         </listitem>
 276       </varlistentry>
 277
 278       <varlistentry>
 279         <term>-x</term>
 280
 281         <listitem>
 282           <para>File system mount points are not traversed.</para>
 283         </listitem>
 284       </varlistentry>
 285     </variablelist>
 286   </refsect1>
 287
 288   <refsect1>
 289     <title>ad mv</title>
 290
 291     <para>Move files and directories.</para>
 292
 293     <para>Move files around within an AFP volume, updating the CNID database
 294     as needed. If either:<itemizedlist>
 295         <listitem>
 296           <para>source or destination is not an AFP volume</para>
 297         </listitem>
 298
 299         <listitem>
 300           <para>source AFP volume != destination AFP volume</para>
 301         </listitem>
 302       </itemizedlist>the files are copied and removed from the source.</para>
 303
 304     <para>Options:</para>
 305
 306     <variablelist>
 307       <varlistentry>
 308         <term>-f</term>
 309
 310         <listitem>
 311           <para>Do not prompt for confirmation before overwriting the
 312           destination path. (The -f option overrides any previous -i or -n
 313           options.)</para>
 314         </listitem>
 315       </varlistentry>
 316
 317       <varlistentry>
 318         <term>-i</term>
 319
 320         <listitem>
 321           <para>Cause mv to write a prompt to standard error before moving a
 322           file that would overwrite an existing file. If the response from the
 323           standard input begins with the character `y' or `Y', the move is
 324           attempted. (The -i option overrides any previous -f or -n
 325           options.)</para>
 326         </listitem>
 327       </varlistentry>
 328
 329       <varlistentry>
 330         <term>-n</term>
 331
 332         <listitem>
 333           <para>Do not overwrite an existing file. (The -n option overrides
 334           any previous -f or -i options.)</para>
 335         </listitem>
 336       </varlistentry>
 337
 338       <varlistentry>
 339         <term>-v</term>
 340
 341         <listitem>
 342           <para>Cause mv to be verbose, showing files after they are
 343           moved.</para>
 344         </listitem>
 345       </varlistentry>
 346     </variablelist>
 347   </refsect1>
 348
 349   <refsect1>
 350     <title>ad rm</title>
 351
 352     <para>Remove files and directories.</para>
 353
 354     <para>The rm utility attempts to remove the non-directory type files
 355     specified on the command line. If the files and directories reside on an
 356     AFP volume, the corresponding CNIDs are deleted from the volumes
 357     database.</para>
 358
 359     <para>The options are as follows:</para>
 360
 361     <variablelist>
 362       <varlistentry>
 363         <term>-R</term>
 364
 365         <listitem>
 366           <para>Attempt to remove the file hierarchy rooted in each file
 367           argument.</para>
 368         </listitem>
 369       </varlistentry>
 370
 371       <varlistentry>
 372         <term>-v</term>
 373
 374         <listitem>
 375           <para>Be verbose when deleting files, showing them as they are
 376           removed.</para>
 377         </listitem>
 378       </varlistentry>
 379     </variablelist>
 380   </refsect1>
 381
 382   <refsect1>
 383     <title>Reporting Bugs</title>
 384
 385     <para>Report bugs to the Netatalk-devel list
 386     &lt;netatalk-devel@lists.sourceforge.net&gt;.</para>
 387   </refsect1>
 388
 389   <refsect1>
 390     <title>See also</title>
 391
 392     <para><citerefentry>
 393         <refentrytitle>dbd</refentrytitle>
 394
 395         <manvolnum>1</manvolnum>
 396       </citerefentry>, <citerefentry>
 397         <refentrytitle>apple_dump</refentrytitle>
 398
 399         <manvolnum>1</manvolnum>
 400       </citerefentry>.</para>
 401   </refsect1>
 402 </refentry>