man/man8/afpd.8.tmpl

   1 '\" t
   2 .\"     Title: afpd
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.78.0 <http://docbook.sf.net/>
   5 .\"      Date: 19 Jan 2013
   6 .\"    Manual: Netatalk 3.0
   7 .\"    Source: Netatalk 3.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AFPD" "8" "19 Jan 2013" "Netatalk 3.0" "Netatalk 3.0"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 afpd \- Apple Filing Protocol daemon
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u
  34 \fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR]
  35 .br
  36 \fBafpd\fR\fB\fR \-v | \-V | \-h
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBafpd\fR
  40 provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time by
  41 \fBnetatalk\fR(8)\&.
  42 .PP
  43 :ETCDIR:/afp\&.conf
  44 is the configuration file used by
  45 \fBafpd\fR
  46 to determine the behavior and configuration of a file server\&.
  47 .SH "OPTIONS"
  48 .PP
  49 \-d
  50 .RS 4
  51 Specifies that the daemon should not fork\&.
  52 .RE
  53 .PP
  54 \-v
  55 .RS 4
  56 Print version information and exit\&.
  57 .RE
  58 .PP
  59 \-V
  60 .RS 4
  61 Print verbose information and exit\&.
  62 .RE
  63 .PP
  64 \-h
  65 .RS 4
  66 Print help and exit\&.
  67 .RE
  68 .PP
  69 \-F \fIconfigfile\fR
  70 .RS 4
  71 Specifies the configuration file to use\&. (Defaults to
  72 :ETCDIR:/afp\&.conf\&.)
  73 .RE
  74 .SH "SIGNALS"
  75 .PP
  76 To shut down a user\*(Aqs
  77 \fBafpd\fR
  78 process it is recommended that
  79 \fBSIGKILL (\-9)\fR
  80 \fINOT\fR
  81 be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
  82 \fBafpd\fR
  83 is to send it a
  84 \fBSIGTERM (\-15)\fR
  85 signal and wait for it to die on its own\&.
  86 .PP
  87 SIGTERM and SIGUSR1 signals that are sent to the main
  88 \fBafpd\fR
  89 process are propagated to the children, so all will be affected\&.
  90 .PP
  91 SIGTERM
  92 .RS 4
  93 Clean exit\&. Propagates from master to childs\&.
  94 .RE
  95 .PP
  96 SIGQUIT
  97 .RS 4
  98 Send this to the master
  99 \fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&.
 100 .RE
 101 .PP
 102 SIGHUP
 103 .RS 4
 104 Sending a
 105 \fBSIGHUP\fR
 106 to afpd will cause it to reload its configuration files\&.
 107 .RE
 108 .PP
 109 SIGINT
 110 .RS 4
 111 Sending a
 112 \fBSIGINT\fR
 113 to a child
 114 \fBafpd\fR
 115 enables
 116 \fImax_debug\fR
 117 logging for this process\&. The log is sent to the file
 118 /tmp/afpd\&.PID\&.XXXXXX\&. Sending another
 119 \fBSIGINT\fR
 120 will revert to the original log settings\&.
 121 .RE
 122 .PP
 123 SIGUSR1
 124 .RS 4
 125 The
 126 \fBafpd\fR
 127 process will send the message "The server is going down for maintenance\&." to the client and shut itself down in 5 minutes\&. New connections are not allowed\&. If this is sent to a child afpd, the other children are not affected\&. However, the main process will still exit, disabling all new connections\&.
 128 .RE
 129 .PP
 130 SIGUSR2
 131 .RS 4
 132 The
 133 \fBafpd\fR
 134 process will look in the message directory configured at build time for a file named message\&.pid\&. For each one found, a the contents will be sent as a message to the associated AFP client\&. The file is removed after the message is sent\&. This should only be sent to a child
 135 \fBafpd\fR\&.
 136 .RE
 137 .SH "FILES"
 138 .PP
 139 :ETCDIR:/afp\&.conf
 140 .RS 4
 141 configuration file used by afpd
 142 .RE
 143 .PP
 144 :STATEDIR:/netatalk/afp_signature\&.conf
 145 .RS 4
 146 list of server signature
 147 .RE
 148 .PP
 149 :STATEDIR:/netatalk/afp_voluuid\&.conf
 150 .RS 4
 151 list of UUID for Time Machine volume
 152 .RE
 153 .PP
 154 :ETCDIR:/extmap\&.conf
 155 .RS 4
 156 file name extension mapping
 157 .RE
 158 .PP
 159 :ETCDIR:/msg/message\&.pid
 160 .RS 4
 161 contains messages to be sent to users\&.
 162 .RE
 163 .SH "SEE ALSO"
 164 .PP
 165 \fBnetatalk\fR(8),
 166 \fBhosts_access\fR(5),
 167 \fBafp.conf\fR(5),
 168 \fBafp_signature.conf\fR(5),
 169 \fBafp_voluuid.conf\fR(5),
 170 \fBextmap.conf\fR(5),
 171 \fBdbd\fR(1)\&.