forked from ajacoutot/toad
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtoad.8
118 lines (116 loc) · 2.79 KB
/
toad.8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.\"
.\" Copyright (c) 2021 jpz4085
.\" Copyright (c) 2016 Antoine Jacoutot <[email protected]>
.\" Copyright (c) 2013 M:tier Ltd.
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\"
.Dd $Mdocdate: March 25 2021 $
.Dt TOAD 8
.Os
.Sh NAME
.Nm toad
.Nd
device automounter for
.Xr hotplugd 8
.Sh SYNOPSIS
.Nm
.Bk -words
.Ar action
.Ar devclass
.Ar devname
.Ek
.Sh DESCRIPTION
.Nm
(Toad Opens All Devices)
is a utility meant to be started from the
.Xr hotplugd 8
.Em attach
and
.Em detach
scripts.
It will attempt to mount all supported partitions on the device under
.Pa /media/${USER}/device .
Where ${USER} is the active user
.Em login
name and
.Em device
is either the partition volume label or the disk label description
followed by a partition number (ex. Sandisk Cruzer-p1). Mounting
uses the hotplug-diskmount(8) command and follows the
.Em udev
hierarchy in Linux which allows interaction with GLib/GIO's GUnixMount.
.Pp
Users outside the default UID range (1000...60000) are ignored (nothing will
be done).
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Ar action
Can be
.Ar attach
(for device attachment)
or
.Ar detach
(for device detachment).
.It Ar devclass
Integer corresponding to the device class as described in the
.Aq Pa sys/device.h
header file, e.g.\&
.Pa 2
for disk drives.
.It Ar devname
Device name as listed in
.Xr MAKEDEV 8 ,
and the unit number, e.g.\&
.Pa sd1 .
.El
.Pp
Detection of the currently active user is done using ConsoleKit and DBus,
.Nm
will not do anything unless these are properly setup and running.
Obviously,
.Xr hotplugd 8
must be running as well.
.Xr rcctl 8
can be used to enable and start
.Xr hotplugd 8
and
.Xr dbus-daemon 1 :
.Bd -literal -offset indent
.Ev rcctl enable hotplugd messagebus
.Ev rcctl start hotplugd messagebus
.Ed
.Sh EXAMPLES
This sample code can be used for both the
.Em attach
and
.Em detach
scripts:
.Bd -literal -offset indent
#!/bin/sh
DEVCLASS=$1
DEVNAME=$2
case $DEVCLASS in
2)
/usr/local/libexec/toad ${0##*/} $DEVCLASS $DEVNAME
;;
esac
.Ed
.Sh SEE ALSO
.Xr dbus-daemon 1 ,
.Xr hotplugd 8 ,
.Xr hotplug-diskmount 8
.Sh AUTHORS
.An Antoine Jacoutot Aq Mt [email protected]