1UDISKIE(8) udiskie UDISKIE(8)
2
6 udiskie - automounter for removable media
7
9 udiskie [OPTIONS]
10 udiskie-mount [OPTIONS] (-a | DEVICE...)
12 udiskie-umount [OPTIONS] (-a | PATH...)
14
16 udiskie is a front-end for UDisks written in python. Its main purpose
17 is automatically mounting removable media, such as CDs or flash drives.
18 It has optional mount notifications, a GTK tray icon and user level
19 CLIs for manual mount and unmount operations. The media will be mounted
20 in a new directory under /media or /run/media/USER/, using the device
21 name if possible.
22
24 -h, --help
25 Show help message and exit.
26 -V, --version
28 Show help message and exit.
29 -v, --verbose
31 Verbose output.
32 -q, --quiet
34 Quiet output.
35 -0, --udisks-auto
37 Auto discover UDisks version (default). Prefers UDisks2 if both are
38 available.
39 -1, --use-udisks1
41 Use UDisks1 as DBus backend.
42 -2, --use-udisks2
44 Use UDisks2 as DBus backend.
45 -c FILE, --config=FILE
47 Specify config file.
48 -C, --no-config
50 Don’t use any config file.
51
53 -p COMMAND, --password-prompt=COMMAND
54 Password retrieval command. The string is formatted with the device
55 attributes as keyword arguments, e.g.:
56 -p "zenity --entry --hide-text --text 'Enter password for {device_presentation}:'"
58 -P, --no-password-prompt
60 Disable unlocking of LUKS devices.
61
63 -a, --automount
64 Enable automounting new devices (default).
65 -A, --no-automount
67 Disable automounting new devices.
68 -n, --notify
70 Enable pop-up notifications (default).
71 -N, --no-notify
73 Disable pop-up notifications.
74 -t, --tray
76 Show tray icon.
77 -s, --smart-tray
79 Show tray icon that automatically hides when there is no action
80 available.
81 -T, --no-tray
83 Disable tray icon (default).
84 -f PROGRAM, --file-manager=PROGRAM
86 Set program to open mounted directories. Default is 'xdg-open'.
87 Pass an empty string to disable this feature. This option is
88 deprecated and will probably be replaced by a python commands file.
89 -F, --no-file-manager
91 Disable browsing.
92 -appindicator
94 Use AppIndicator3 for the status icon. Use this on Ubuntu/Unity if
95 no icon is shown.
96 --no-appindicator
98 Use Gtk.StatusIcon for the status icon (default).
99 --password-cache MINUTES
101 Cache passwords for LUKS partitions and set the timeout.
102 --no-password-cache
104 Never cache passwords (default).
105 --notify-command COMMAND
107 Command to execute on device events. Command string be formatted
108 using the event name and the list of device attributes (see below),
109 e.g.:
110 --notify-command "zenity --info --text '{event}: {device_presentation}'"
112 --no-notify-command
114 No notify command (default).
115
117 -a, --all
118 Mount all handled devices.
119 -r, --recursive
121 Recursively mount cleartext partitions after unlocking a LUKS
122 device. This will happen by default when running the udiskie
123 daemon.
124 -R, --no-recursive
126 Disable recursive mounting (default).
127 -o OPTIONS, --options=OPTIONS
129 Set mount options.
130
132 -a, --all
133 Unmount all handled devices.
134 -d, --detach
136 Detach drive by e.g. powering down its physical port.
137 -D, --no-detach
139 Don’t detach drive (default).
140 -e, --eject
142 Eject media from the drive, e.g CDROM.
143 -E, --no-eject
145 Don’t eject media (default).
146 -f, --force
148 Force removal (recursive unmounting).
149 -F, --no-force
151 Don’t force removal (default).
152 -l, --lock
154 Lock device after unmounting (default).
155 -L, --no-lock
157 Don’t lock device.
158
160 Start udiskie in ~/.xinitrc:
161 udiskie &
163 Unmount media and power down USB device:
165 udiskie-umount --detach /media/Sticky
167 Mount all media:
169 udiskie-mount -a
171 Mount /dev/sdb1:
173 udiskie-mount /dev/sdb1
175
177 The file .config/udiskie/config.yml can be used to configure defaults
178 for command line parameters and customize further settings. The actual
179 path may differ depending on $XDG_CONFIG_HOME. The file format is YAML,
180 see http://en.wikipedia.org/wiki/YAML. If you don’t want to install
181 PyYAML, it is possible to use an equivalent JSON file with the name
182 config.json instead.
183 # This is an example (nonsense) configuration file for udiskie.
185 program_options:
187 # Configure defaults for command line options
188 udisks_version: 2 # [int] Specify the version of udisks
190 # to be used. Set to 0 to use automatic
191 # discovery.
192 tray: auto # [bool] Enable the tray icon. "auto"
194 # means auto-hide the tray icon when
195 # there are no handled devices.
196 menu: flat # ["flat" | "nested"] Set the
198 # systray menu behaviour.
199 automount: false # [bool] Enable automatic mounting.
201 notify: true # [bool] Enable notifications.
203 password_cache: 30 # [int] Password cache in minutes. Caching is
205 # disabled by default. It can be disabled
206 # explicitly by setting it to false
207 file_manager: xdg-open
209 # [string] Set program to open directories. It will be invoked
210 # with the folder path as its first command line argument.
211 password_prompt: ["gnome-keyring-query", "get", "{id_uuid}"]
213 # [string|list] Set command to retrieve passwords. If specified
214 # as a list it defines the ARGV array for the program call. If
215 # specified as a string, it will be expanded in a shell-like
216 # manner. Each string will be formatted using `str.format`. For a
217 # list of device attributes, see below. The two special string values
218 # "builtin:gui" and "builtin:tty" signify to use udiskie's
219 # builtin password prompt.
220 notify_command: "zenity --info --text '{event}: {device_presentation}'"
222 # [string|list] Set command to be executed on any device event.
223 # This is specified like `password_prompt`.
224 device_config:
226 # List of device option rules. Each item can match any combination of device
228 # attributes. Additionally, it defines the resulting action (see below).
229 # Any rule can contain multliple filters (AND) and multiple actions.
230 # Only the first matching rule that defines a given action is used.
231 # The rules defined here are simply prepended to the builtin device rules,
232 # so that it is possible to completely overwrite the defaults by specifying
233 # a catch-all rule (i.e. a rule without device attributes).
234 - device_file: /dev/dm-5 # [filter]
236 ignore: false # [action] never ignore this device
237 - id_uuid: 9d53-13ba # [filter] match by device UUID
238 options: [noexec, nodev] # [action] mount options can be given as list
239 ignore: false # [action] never ignore this device (even if fs=FAT)
240 automount: false # [action] do not automount this device
241 - id_type: vfat # [filter] match file system type
242 ignore: true # [action] ignore all FAT devices
243 - ignore: True # never mount/unmount or even show this in the GUI
245 automount: False # show but do not automount this device
246 options: [] # additional options to be passed when mounting
247 mount_options: # [deprecated] do not use
249 ignore_device: # [deprecated] do not use
250 notifications:
252 # Customize which notifications are shown for how long. Possible
253 # values are:
254 # positive number timeout in seconds
255 # false disable
256 # -1 use the libnotify default timeout
257 timeout: 1.5 # set the default for all notifications
259 # Specify only if you want to overwrite the the default:
261 device_mounted: 5 # mount notification
262 device_unmounted: false # unmount notification
263 device_added: false # device has appeared
264 device_removed: false # device has disappeared
265 device_unlocked: -1 # encrypted device was unlocked
266 device_locked: -1 # encrypted device was locked
267 job_failed: -1 # mount/unlock/.. has failed
268 notification_actions:
270 # Define which actions should be shown on notifications. Note that there
271 # are currently only a limited set of actions available for each
272 # notification. Events that are not explicitly specified show the default
273 # set of actions. Specify an empty list if you don't want to see any
274 # notification for the specified event:
275 device_mounted: [browse]
277 device_added: [mount]
278 icon_names:
280 # Customize the icon set used by the tray widget. Each entry
281 # specifies a list of icon names. The first installed icon from
282 # that list will be used.
283 media: [drive-removable-media, media-optical]
285 browse: [document-open, folder-open]
286 mount: [udiskie-mount]
287 unmount: [udiskie-unmount]
288 unlock: [udiskie-unlock]
289 lock: [udiskie-lock]
290 eject: [udiskie-eject, media-eject]
291 detach: [udiskie-detach]
292 delete: [udiskie-eject]
293 quit: [application-exit]
294 All keys are optional. Reasonable defaults are used if you leave them
296 unspecified.
297
299 Some of the config entries make use of Device attributes. The following
300 list of attributes is currently available, but there is no guarantee
301 that they will remain available:
302 Attribute Hint/Example
304 is_drive
306 is_block
307 is_partition_table
308 is_partition
309 is_filesystem
310 is_luks
311 is_loop
312 is_toplevel
313 is_detachable
314 is_ejectable
315 has_media
316 device_file block device path, e.g. "/dev/sdb1"
317 device_presentation display string, e.g. "/dev/sdb1"
318 device_id unique, persistent device identifier
319 id_usage E.g. "filesystem" or "crypto"
320 is_crypto
321 is_ignored
322 id_type E.g. "ext4" or "crypto_LUKS"
323 id_label device label
324 id_uuid device UUID
325 is_luks_cleartext
326 is_external udisks flag HintSystem=false
327 is_systeminternal udisks flag HintSystem=true
328 is_mounted
329 mount_paths list of mount paths
330 mount_path any mount path
331 is_unlocked
332 in_use device or any of its children mounted
333 should_automount
334 ui_label
335 loop_file file backing the loop device
336 setup_by_uid user that setup the loop device
337 autoclear automatically delete loop device after use
338 symlinks
339 drive_model
340 drive_vendor
341 drive_label
342 ui_device_label
343 ui_device_presentation
344 ui_id_label
345 ui_id_uuid
346
348 udisks(1)
349 http://www.freedesktop.org/wiki/Software/udisks/
351
353 You can use the github issues to report any issues you encounter, ask
354 general questions or suggest new features. If you don’t have or like
355 github, you can contact me by email:
356 https://github.com/coldfix/udiskie/issues
358 thomas@coldfix.de
360udiskie 07/27/2019 UDISKIE(8)