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