Initial import package mtools: Programs for accessing MS-DOS disks without mounting...
[pkgs/m/mtools.git] / floppyd.1
1 .TH floppyd 1 "03Nov09" mtools-4.0.12
2 .SH Name
3 floppyd - floppy daemon for remote access to floppy drive
4 floppyd_installtest - tests whether floppyd is installed and running
5 '\" t
6 .de TQ
7 .br
8 .ns
9 .TP \\$1
10 ..
11
12 .tr \(is'
13 .tr \(if`
14 .tr \(pd"
15
16 .SH Note\ of\ warning
17 This manpage has been automatically generated from mtools's texinfo
18 documentation, and may not be entirely accurate or complete.  See the
19 end of this man page for details.
20 .PP
21 .SH Description
22 .iX "p floppyd"
23 .iX "c X terminal"
24 .iX "c remote floppy access"
25 .PP
26 \&\fR\&\f(CWFloppyd\fR is used as a server to grant access to the floppy drive
27 to clients running on a remote machine, just as an X server grants
28 access to the display to remote clients.  It has the following syntax:
29 .PP
30 \&\fR\&\f(CWfloppyd\fR [\fR\&\f(CW-d\fR] [\fR\&\f(CW-l\fR] [\fR\&\f(CW-s\fR \fIport\fR] [\fR\&\f(CW-r\fR
31 \&\fIuser\fR] [\fR\&\f(CW-b\fR \fIipaddr\fR] [\fR\&\f(CW-x\fR \fIdisplay\fR] \fIdevicenames\fR
32 .PP
33 \&\fR\&\f(CWfloppyd\fR is always associated with an X server.  It runs on the
34 same machine as its X server, and listens on port 5703 and above.
35 .PP
36 .SH Authentication
37 .PP
38 \&\fR\&\f(CWfloppyd\fR authenticates remote clients using the \fR\&\f(CWXauthority\fR
39 protocol. Xhost authentication is not supported. Each floppyd is
40 associated with an X server.  When a remote client attempts to connect
41 to floppyd, it sends floppyd the X authority record corresponding to
42 floppyd's X server.  Floppyd in turn then tries to open up a connection
43 to the X server in order to verify the authenticity of the xauth record.
44 If the connection to the X server succeeds, the client is granted
45 access.
46 \&\fR\&\f(CWDISPLAY\fR.
47 .PP
48 \&\fBCaution\fR: In order to make authentication work correctly, the
49 local host should \fBnot\fR be listed in the \fR\&\f(CWxhost\fR list of
50 allowed hosts.
51  Indeed, hosts listed in \fR\&\f(CWxhost\fR do not need a correct
52 \&\fR\&\f(CWXauthority\fR cookie to connect to the X server. As \fR\&\f(CWfloppyd\fR
53 runs on the same host as the X server, all its probe connection would
54 succeed even for clients who supplied a bad cookie.  This means that
55 your floppy drive would be open to the world, i.e. a huge security hole.
56  If your X server does not allow you to remove \fR\&\f(CWlocalhost:0\fR and
57 \&\fR\&\f(CW:0\fR from the \fR\&\f(CWxhost\fR list, you can prevent floppyd from
58 probing those display names with the \fR\&\f(CW-l\fR option.
59 .PP
60 .SH Command\ line\ options
61 .TP
62 \&\fR\&\f(CWd\fR\ 
63 Daemon mode. Floppyd runs its own server loop.  Do not supply this if
64 you start floppyd from \fR\&\f(CWinetd.conf\fR
65 .TP
66 \&\fR\&\f(CWs\ \ \fIport\fR\&\f(CW\fR\ 
67 Port number for deamon mode.  Default is 5703 + \fIdisplaynumber\fR.
68 This flag implies daemon mode.  For example, for display
69 \&\fR\&\f(CWhitchhiker:5\fR, the port would be 5708.
70 .TP
71 \&\fR\&\f(CWb\ \ \fIipaddr\fR\&\f(CW\fR\ 
72 Bind address (for multihomed hosts). This flag implies daemon mode
73 .TP
74 \&\fR\&\f(CWr\ \fIuser\fR\&\f(CW\fR\ 
75 Run the server under as the given user
76 .TP
77 \&\fR\&\f(CWx\ \fIdisplay\fR\&\f(CW\fR\ 
78 X display to use for authentication. By default, this is taken from the
79 \&\fR\&\f(CWDISPLAY\fR variable. If neither the \fR\&\f(CWx\fR attribute is present
80 nor \fR\&\f(CWDISPLAY\fR is set, floppyd uses \fR\&\f(CW:0.0\fR.
81 .PP
82 \&\fIdevicenames\fR is a list of device nodes to be opened.  Default
83 is \fR\&\f(CW/dev/fd0\fR. Multiple devices are only supported on mtools
84 versions newer than 3.9.11.
85 .PP
86 .SH Connecting\ to\ floppyd
87 .PP
88  In order to use floppyd, add the flag \fR\&\f(CWremote\fR to the device
89 description in your \fR\&\f(CW\(if~/.mtoolsrc\(is\fR file.  If the flag \fR\&\f(CWremote\fR
90 is given, the \fR\&\f(CWfile\fR parameter of the device description is taken
91 to be a remote address.  It's format is the following:
92 \&\fIhostname\fR\fR\&\f(CW:\fR\fIdisplaynumber\fR[\fR\&\f(CW/\fR[\fIbaseport\fR][\fR\&\f(CW/\fR\fIdrive\fR]]. When
93 using this entry, mtools connects to port
94 \&\fIbaseport\fR+\fIdisplaynumber\fR at \fIhostname\fR. By default
95 \&\fIbaseport\fR is 5703. The drive parameter is to distinguish among
96 multiple drives associated with a single display (only mtools versions
97 more recent than 3.9.11)
98 .PP
99 .SH Examples:
100 .PP
101  The following starts a floppy daemon giving access to \fR\&\f(CW\(if/dev/fd0\(is\fR,
102 listening on the default port 5703, tied to the default X servers:
103 .PP
104  
105 .nf
106 .ft 3
107 .in +0.3i
108 floppyd -d /dev/fd0
109 .fi
110 .in -0.3i
111 .ft R
112 .lp
113  
114 \&\fR
115 .PP
116  Each of the following starts a floppy daemon giving access to
117 \&\fR\&\f(CW\(if/dev/fd1\(is\fR, tied to the :1 local X servers, and listening on port
118 5704. We assume that the local host is named \fR\&\f(CWhitchhiker\fR.
119 .PP
120  
121 .nf
122 .ft 3
123 .in +0.3i
124 floppyd -d /dev/fd0
125 floppyd -d -x :1 -p 5704 /dev/fd0 
126 .fi
127 .in -0.3i
128 .ft R
129 .lp
130  
131 \&\fR
132 .PP
133  If you want to start floppyd by \fR\&\f(CWinetd\fR instead of running it as a 
134 daemon, insert the following lines into \fR\&\f(CW\(if/etc/services\(is\fR:
135  
136 .nf
137 .ft 3
138 .in +0.3i
139 # floppy daemon
140 floppyd-0    5703/tcp    # floppy daemon for X server :0
141 floppyd-1    5704/tcp    # floppy daemon for X server :1
142 .fi
143 .in -0.3i
144 .ft R
145 .lp
146  
147 \&\fR
148 .PP
149  And insert the following into \fR\&\f(CW\(if/etc/inetd.conf\(is\fR (assuming that you
150 have defined a user named floppy in your \fR\&\f(CW\(if/etc/passwd\(is\fR):
151 .PP
152  
153 .nf
154 .ft 3
155 .in +0.3i
156 # floppy daemon
157 floppyd-0 stream  tcp  wait  floppy  /usr/sbin/floppyd floppyd /dev/fd0 
158 floppyd-1 stream  tcp  wait  floppy  /usr/sbin/floppyd floppyd -x :1 /dev/fd0 
159 .fi
160 .in -0.3i
161 .ft R
162 .lp
163  
164 \&\fR
165 .PP
166  Note that you need to supply the X display names for the second
167 floppyd.  This is because the port is opened by inetd.conf, and hence
168 floppyd cannot know its number to interfere the display number.
169 .PP
170 On the client side, insert the following into your \fR\&\f(CW\(if~/.mtoolsrc\(is\fR
171 to define a drive letter accessing floppy drive in your X terminal:
172  
173 .nf
174 .ft 3
175 .in +0.3i
176 drive x: file="$DISPLAY" remote
177 .fi
178 .in -0.3i
179 .ft R
180 .lp
181  
182 \&\fR
183 .PP
184 If your X terminal has more than one drive, you may access the
185 additional drives as follows:
186  
187 .nf
188 .ft 3
189 .in +0.3i
190 drive y: file="$DISPLAY//1" remote
191 drive z: file="$DISPLAY//2" remote
192 .fi
193 .in -0.3i
194 .ft R
195 .lp
196  
197 \&\fR
198 .PP
199 .SH See\ Also
200 Mtools' texinfo doc
201 .SH Viewing\ the\ texi\ doc
202 This manpage has been automatically generated from mtools's texinfo
203 documentation. However, this process is only approximative, and some
204 items, such as crossreferences, footnotes and indices are lost in this
205 translation process.  Indeed, these items have no appropriate
206 representation in the manpage format.  Moreover, not all information has
207 been translated into the manpage version.  Thus I strongly advise you to
208 use the original texinfo doc.  See the end of this manpage for
209 instructions how to view the texinfo doc.
210 .TP
211 * \ \ 
212 To generate a printable copy from the texinfo doc, run the following
213 commands:
214  
215 .nf
216 .ft 3
217 .in +0.3i
218     ./configure; make dvi; dvips mtools.dvi
219 .fi
220 .in -0.3i
221 .ft R
222 .lp
223  
224 \&\fR
225 .TP
226 * \ \ 
227 To generate a html copy,  run:
228  
229 .nf
230 .ft 3
231 .in +0.3i
232     ./configure; make html
233 .fi
234 .in -0.3i
235 .ft R
236 .lp
237  
238 \&\fRA premade html can be found at
239 \&\fR\&\f(CW\(ifhttp://www.gnu.org/software/mtools/manual/mtools.html\(is\fR
240 .TP
241 * \ \ 
242 To generate an info copy (browsable using emacs' info mode), run:
243  
244 .nf
245 .ft 3
246 .in +0.3i
247     ./configure; make info
248 .fi
249 .in -0.3i
250 .ft R
251 .lp
252  
253 \&\fR
254 .PP
255 The texinfo doc looks most pretty when printed or as html.  Indeed, in
256 the info version certain examples are difficult to read due to the
257 quoting conventions used in info.
258 .PP