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