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.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 23 Mar 2012
   6 .\"    Manual: Netatalk 3.0
   7 .\"    Source: Netatalk 3.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AFPD" "8" "23 Mar 2012" "Netatalk 3.0" "Netatalk 3.0"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 afpd \- Apple Filing Protocol daemon
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBafpd\fR\fB\fR\fBafpd\fR\fB\fR\ 'u
  25 \fBafpd\fR\fB\fR [\-d] [\-F\ \fIconfigfile\fR]
  26 .br
  27 \fBafpd\fR\fB\fR \-v | \-V | \-h
  28 .SH "DESCRIPTION"
  29 .PP
  30 \fBafpd\fR
  31 provides an Apple Filing Protocol (AFP) interface to the Unix file system\&. It is normally started at boot time by
  32 \fBnetatalk\fR(8)\&.
  33 .PP
  34 :ETCDIR:/afp\&.conf
  35 is the configuration file used by
  36 \fBafpd\fR
  37 to determine the behavior and configuration of a file server\&.
  38 .SH "OPTIONS"
  39 .PP
  40 \-d
  41 .RS 4
  42 Specifies that the daemon should not fork\&.
  43 .RE
  44 .PP
  45 \-v
  46 .RS 4
  47 Print version information and exit\&.
  48 .RE
  49 .PP
  50 \-V
  51 .RS 4
  52 Print verbose information and exit\&.
  53 .RE
  54 .PP
  55 \-h
  56 .RS 4
  57 Print help and exit\&.
  58 .RE
  59 .PP
  60 \-F \fIconfigfile\fR
  61 .RS 4
  62 Specifies the configuration file to use\&. (Defaults to
  63 :ETCDIR:/afp\&.conf\&.)
  64 .RE
  65 .SH "SIGNALS"
  66 .PP
  67 To shut down a user\'s
  68 \fBafpd\fR
  69 process it is recommended that
  70 \fBSIGKILL (\-9)\fR
  71 \fINOT\fR
  72 be used, except as a last resort, as this may leave the CNID database in an inconsistent state\&. The safe way to terminate an
  73 \fBafpd\fR
  74 is to send it a
  75 \fBSIGTERM (\-15)\fR
  76 signal and wait for it to die on its own\&.
  77 .PP
  78 SIGTERM and SIGUSR1 signals that are sent to the main
  79 \fBafpd\fR
  80 process are propagated to the children, so all will be affected\&.
  81 .PP
  82 SIGTERM
  83 .RS 4
  84 Clean exit\&. Propagates from master to childs\&.
  85 .RE
  86 .PP
  87 SIGQUIT
  88 .RS 4
  89 Send this to the master
  90 \fBafpd\fR, it will exit leaving all children running! Can be used to implement AFP service without downtime\&.
  91 .RE
  92 .PP
  93 SIGHUP
  94 .RS 4
  95 Sending a
  96 \fBSIGHUP\fR
  97 to afpd will cause it to reload its configuration files\&.
  98 .RE
  99 .PP
 100 SIGINT
 101 .RS 4
 102 Sending a
 103 \fBSIGINT\fR
 104 to a child
 105 \fBafpd\fR
 106 enables
 107 \fImax_debug\fR
 108 logging for this process\&. The log is sent to fhe file
 109 /tmp/afpd\&.PID\&.XXXXXX\&. Sending another
 110 \fBSIGINT\fR
 111 will revert to the original log settings\&.
 112 .RE
 113 .PP
 114 SIGUSR1
 115 .RS 4
 116 The
 117 \fBafpd\fR
 118 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\&.
 119 .RE
 120 .PP
 121 SIGUSR2
 122 .RS 4
 123 The
 124 \fBafpd\fR
 125 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
 126 \fBafpd\fR\&.
 127 .RE
 128 .SH "FILES"
 129 .PP
 130 :ETCDIR:/afp\&.conf
 131 .RS 4
 132 configuration file used by afpd
 133 .RE
 134 .PP
 135 :STATEDIR:/netatalk/afp_signature\&.conf
 136 .RS 4
 137 list of server signature
 138 .RE
 139 .PP
 140 :STATEDIR:/netatalk/afp_voluuid\&.conf
 141 .RS 4
 142 list of UUID for Time Machine volume
 143 .RE
 144 .PP
 145 :ETCDIR:/msg/message\&.pid
 146 .RS 4
 147 contains messages to be sent to users\&.
 148 .RE
 149 .SH "SEE ALSO"
 150 .PP
 151 \fBnetatalk\fR(8),
 152 \fBhosts_access\fR(5),
 153 \fBafp.conf\fR(5),
 154 \fBafp_signature.conf\fR(5),
 155 \fBafp_voluuid.conf\fR(5),
 156 \fBdbd\fR(1)\&.