Merge branch 'develop'

[netatalk.git] / man / man1 / apple_dump.1

diff --git a/man/man1/apple_dump.1 b/man/man1/apple_dump.1
index d915cd8cdfe43db2884537e0f2068587e189225c..37e9f6e649763563fd9fb1355dc531cf11a170fd 100644 (file)
--- a/man/man1/apple_dump.1
+++ b/man/man1/apple_dump.1
@@ -2,12 +2,12 @@
 .\"     Title: apple_dump
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 31 Mar 2010
-.\"    Manual: Netatalk 2.1
-.\"    Source: Netatalk 2.1
+.\"      Date: 16 Jul 2012
+.\"    Manual: Netatalk 3.0
+.\"    Source: Netatalk 3.0
 .\"  Language: English
 .\"
-.TH "APPLE_DUMP" "1" "31 Mar 2010" "Netatalk 2.1" "Netatalk 2.1"
+.TH "APPLE_DUMP" "1" "16 Jul 2012" "Netatalk 3.0" "Netatalk 3.0"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -19,45 +19,63 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-apple_dump \- Dump AppleSingle/AppleDouble format file
+apple_dump \- Dump AppleSingle/AppleDouble format data
 .SH "SYNOPSIS"
-.HP \w'\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\ 'u
-\fBapple_dump\fR\fB\fR [\-a] \fIFILE\fR | \fIDIR\fR 
+.HP \w'\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\fBapple_dump\fR\fB\fR\ 'u
+\fBapple_dump\fR\fB\fR [\-a] [\fIFILE\fR | \fIDIR\fR]
 .br
-\fBapple_dump\fR\fB\fR \-f \fIFILE\fR
+\fBapple_dump\fR\fB\fR \-e \fIFILE\fR | \fIDIR\fR 
 .br
-\fBapple_dump\fR\fB\fR \-d \fIFILE\fR
+\fBapple_dump\fR\fB\fR \-f [\fIFILE\fR]
+.br
+\fBapple_dump\fR\fB\fR \-d [\fIFILE\fR]
 .br
 \fBapple_dump\fR\fB\fR \-h | \-help | \-\-help 
+.br
+\fBapple_dump\fR\fB\fR \-v | \-version | \-\-version 
 .SH "DESCRIPTION"
 .PP
 \fBapple_dump\fR
-dump AppleSingle/AppleDouble format file\&.
+is a perl script to dump AppleSingle/AppleDouble format data\&.
+.PP
+This script can dump various AppleSingle/AppleDouble data created by mailer, archiver, Mac OS X, Netatalk and so on\&.
+.PP
+With no
+\fIFILE\fR|\fIDIR\fR, or when
+\fIFILE\fR|\fIDIR\fR
+is \-, read standard input\&.
 .SH "OPTIONS"
 .PP
-\fB\-a\fR \fIFILE\fR|\fIDIR\fR
+\fB\-a\fR [\fIFILE\fR|\fIDIR\fR]
 .RS 4
 This is default\&. Dump a AppleSingle/AppleDouble file for
 \fIFILE\fR
 or
 \fIDIR\fR
-automatically\&. Extrapolate FinderInfo type from absolute path\&. If FILE is not AppleSingle/AppleDouble format, look for
+automatically\&. If FILE is not AppleSingle/AppleDouble format, look for extended attribute,
 \fI\&.AppleDouble/FILE\fR
 and
 \fI\&._FILE\fR\&. If
-\fIDIR\fR, look for
+\fIDIR\fR, look for extended attribute,
 \fIDIR/\&.AppleDouble/\&.Parent\fR
 and
 \fI\&._DIR\fR\&.
 .RE
 .PP
-\fB\-f\fR \fIFILE\fR
+\fB\-e\fR \fIFILE\fR|\fIDIR\fR
+.RS 4
+Dump extended attribute of\fIFILE\fR
+or
+\fIDIR\fR\&.
+.RE
+.PP
+\fB\-f\fR [\fIFILE\fR]
 .RS 4
 Dump
 \fIFILE\fR\&. Assume FinderInfo to be FileInfo\&.
 .RE
 .PP
-\fB\-d\fR \fIFILE\fR
+\fB\-d\fR [\fIFILE\fR]
 .RS 4
 Dump
 \fIFILE\fR\&. Assume FinderInfo to be DirInfo\&.
@@ -67,11 +85,21 @@ Dump
 .RS 4
 Display the help and exit
 .RE
+.PP
+\fB\-v, \-version, \-\-version\fR
+.RS 4
+Show version and exit
+.RE
 .SH "NOTE"
 .PP
 There is no way to detect whether FinderInfo is FileInfo or DirInfo\&. By default, apple_dump examins whether file or directory, a parent directory is \&.AppleDouble, filename is \&._*, filename is \&.Parent, and so on\&.
 .PP
-If setting option \-f or \-d, assume FinderInfo and doesn\'t look for another file\&.
+If setting option \-e, \-f or \-d, assume FinderInfo and doesn\'t look for another file\&.
 .SH "SEE ALSO"
 .PP
-\fBafile\fR(1)
+\fBad\fR(1),
+\fBgetfattr\fR(1),
+\fBattr\fR(1),
+\fBrunat\fR(1),
+\fBgetextattr\fR(8),
+\fBlsextattr\fR(8)