'\" t .\" Title: udiskie .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 03/30/2017 .\" Manual: udiskie .\" Source: udiskie .\" Language: English .\" .TH "UDISKIE" "8" "03/30/2017" "udiskie" "udiskie" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" udiskie \- automounter for removable media .SH "SYNOPSIS" .sp \fIudiskie\fR [OPTIONS] .sp \fIudiskie\-mount\fR [OPTIONS] (\-a | DEVICE\&...) .sp \fIudiskie\-umount\fR [OPTIONS] (\-a | PATH\&...) .SH "DESCRIPTION" .sp \fBudiskie\fR is a front\-end for UDisks written in python\&. Its main purpose is automatically mounting removable media, such as CDs or flash drives\&. It has optional mount notifications, a GTK tray icon and user level CLIs for manual mount and unmount operations\&. The media will be mounted in a new directory under \fI/media\fR or \fI/run/media/USER/\fR, using the device name if possible\&. .SH "COMMON OPTIONS" .PP \fB\-h, \-\-help\fR .RS 4 Show help message and exit\&. .RE .PP \fB\-V, \-\-version\fR .RS 4 Show help message and exit\&. .RE .PP \fB\-v, \-\-verbose\fR .RS 4 Verbose output\&. .RE .PP \fB\-q, \-\-quiet\fR .RS 4 Quiet output\&. .RE .PP \fB\-0, \-\-udisks\-auto\fR .RS 4 Auto discover UDisks version (default)\&. Prefers UDisks2 if both are available\&. .RE .PP \fB\-1, \-\-use\-udisks1\fR .RS 4 Use UDisks1 as DBus backend\&. .RE .PP \fB\-2, \-\-use\-udisks2\fR .RS 4 Use UDisks2 as DBus backend\&. .RE .PP \fB\-c FILE, \-\-config=FILE\fR .RS 4 Specify config file\&. .RE .PP \fB\-C, \-\-no\-config\fR .RS 4 Don\(cqt use any config file\&. .RE .SH "SHARED MOUNT AND DAEMON OPTIONS" .PP \fB\-p COMMAND, \-\-password\-prompt=COMMAND\fR .RS 4 Password retrieval command\&. The string is formatted with the device attributes as keyword arguments, e\&.g\&.: .sp .if n \{\ .RS 4 .\} .nf \-p "zenity \-\-entry \-\-hide\-text \-\-text \*(AqEnter password for {device_presentation}:\*(Aq" .fi .if n \{\ .RE .\} .RE .PP \fB\-P, \-\-no\-password\-prompt\fR .RS 4 Disable unlocking of LUKS devices\&. .RE .SH "DAEMON OPTIONS" .PP \fB\-a, \-\-automount\fR .RS 4 Enable automounting new devices (default)\&. .RE .PP \fB\-A, \-\-no\-automount\fR .RS 4 Disable automounting new devices\&. .RE .PP \fB\-n, \-\-notify\fR .RS 4 Enable pop\-up notifications (default)\&. .RE .PP \fB\-N, \-\-no\-notify\fR .RS 4 Disable pop\-up notifications\&. .RE .PP \fB\-t, \-\-tray\fR .RS 4 Show tray icon\&. .RE .PP \fB\-s, \-\-smart\-tray\fR .RS 4 Show tray icon that automatically hides when there is no action available\&. .RE .PP \fB\-T, \-\-no\-tray\fR .RS 4 Disable tray icon (default)\&. .RE .PP \fB\-f PROGRAM, \-\-file\-manager=PROGRAM\fR .RS 4 Set program to open mounted directories\&. Default is \*(Aqxdg\-open\*(Aq\&. Pass an empty string to disable this feature\&. This option is deprecated and will probably be replaced by a python commands file\&. .RE .PP \fB\-F, \-\-no\-file\-manager\fR .RS 4 Disable browsing\&. .RE .PP \fB\-appindicator\fR .RS 4 Use AppIndicator3 for the status icon\&. Use this on Ubuntu/Unity if no icon is shown\&. .RE .PP \fB\-\-no\-appindicator\fR .RS 4 Use Gtk\&.StatusIcon for the status icon (default)\&. .RE .PP \fB\-\-password\-cache MINUTES\fR .RS 4 Cache passwords for LUKS partitions and set the timeout\&. .RE .PP \fB\-\-no\-password\-cache\fR .RS 4 Never cache passwords (default)\&. .RE .PP \fB\-\-notify\-command COMMAND\fR .RS 4 Command to execute on device events\&. Command string be formatted using the event name and the list of device attributes (see below), e\&.g\&.: .sp .if n \{\ .RS 4 .\} .nf \-\-notify\-command "zenity \-\-info \-\-text \*(Aq{event}: {device_presentation}\*(Aq" .fi .if n \{\ .RE .\} .RE .PP \fB\-\-no\-notify\-command\fR .RS 4 No notify command (default)\&. .RE .SH "MOUNT OPTIONS" .PP \fB\-a, \-\-all\fR .RS 4 Mount all handled devices\&. .RE .PP \fB\-r, \-\-recursive\fR .RS 4 Recursively mount cleartext partitions after unlocking a LUKS device\&. This will happen by default when running the udiskie daemon\&. .RE .PP \fB\-R, \-\-no\-recursive\fR .RS 4 Disable recursive mounting (default)\&. .RE .PP \fB\-o OPTIONS, \-\-options=OPTIONS\fR .RS 4 Set mount options\&. .RE .SH "UNMOUNT OPTIONS" .PP \fB\-a, \-\-all\fR .RS 4 Unmount all handled devices\&. .RE .PP \fB\-d, \-\-detach\fR .RS 4 Detach drive by e\&.g\&. powering down its physical port\&. .RE .PP \fB\-D, \-\-no\-detach\fR .RS 4 Don\(cqt detach drive (default)\&. .RE .PP \fB\-e, \-\-eject\fR .RS 4 Eject media from the drive, e\&.g CDROM\&. .RE .PP \fB\-E, \-\-no\-eject\fR .RS 4 Don\(cqt eject media (default)\&. .RE .PP \fB\-f, \-\-force\fR .RS 4 Force removal (recursive unmounting)\&. .RE .PP \fB\-F, \-\-no\-force\fR .RS 4 Don\(cqt force removal (default)\&. .RE .PP \fB\-l, \-\-lock\fR .RS 4 Lock device after unmounting (default)\&. .RE .PP \fB\-L, \-\-no\-lock\fR .RS 4 Don\(cqt lock device\&. .RE .SH "EXAMPLE USAGE" .sp Start \fBudiskie\fR in \fI~/\&.xinitrc\fR: .sp .if n \{\ .RS 4 .\} .nf udiskie & .fi .if n \{\ .RE .\} .sp Unmount media and power down USB device: .sp .if n \{\ .RS 4 .\} .nf udiskie\-umount \-\-detach /media/Sticky .fi .if n \{\ .RE .\} .sp Mount all media: .sp .if n \{\ .RS 4 .\} .nf udiskie\-mount \-a .fi .if n \{\ .RE .\} .sp Mount \fI/dev/sdb1\fR: .sp .if n \{\ .RS 4 .\} .nf udiskie\-mount /dev/sdb1 .fi .if n \{\ .RE .\} .SH "CONFIGURATION" .sp The file \fI\&.config/udiskie/config\&.yml\fR can be used to configure defaults for command line parameters and customize further settings\&. The actual path may differ depending on \fI$XDG_CONFIG_HOME\fR\&. The file format is YAML, see http://en\&.wikipedia\&.org/wiki/YAML\&. If you don\(cqt want to install PyYAML, it is possible to use an equivalent JSON file with the name \fIconfig\&.json\fR instead\&. .sp .if n \{\ .RS 4 .\} .nf # This is an example (nonsense) configuration file for udiskie\&. program_options: # Configure defaults for command line options udisks_version: 2 # [int] Specify the version of udisks # to be used\&. Set to 0 to use automatic # discovery\&. tray: auto # [bool] Enable the tray icon\&. "auto" # means auto\-hide the tray icon when # there are no handled devices\&. menu: flat # ["flat" | "nested"] Set the # systray menu behaviour\&. automount: false # [bool] Enable automatic mounting\&. notify: true # [bool] Enable notifications\&. password_cache: 30 # [int] Password cache in minutes\&. Caching is # disabled by default\&. It can be disabled # explicitly by setting it to false file_manager: xdg\-open # [string] Set program to open directories\&. It will be invoked # with the folder path as its first command line argument\&. password_prompt: ["gnome\-keyring\-query", "get", "{id_uuid}"] # [string|list] Set command to retrieve passwords\&. If specified # as a list it defines the ARGV array for the program call\&. If # specified as a string, it will be expanded in a shell\-like # manner\&. Each string will be formatted using `str\&.format`\&. For a # list of device attributes, see below\&. The two special string values # "builtin:gui" and "builtin:tty" signify to use udiskie\*(Aqs # builtin password prompt\&. notify_command: "zenity \-\-info \-\-text \*(Aq{event}: {device_presentation}\*(Aq" # [string|list] Set command to be executed on any device event\&. # This is specified like `password_prompt`\&. device_config: # List of device option rules\&. Each item can match any combination of device # attributes\&. Additionally, it defines the resulting action (see below)\&. # Any rule can contain multliple filters (AND) and multiple actions\&. # Only the first matching rule that defines a given action is used\&. # The rules defined here are simply prepended to the builtin device rules, # so that it is possible to completely overwrite the defaults by specifying # a catch\-all rule (i\&.e\&. a rule without device attributes)\&. \- device_file: /dev/dm\-5 # [filter] ignore: false # [action] never ignore this device \- id_uuid: 9d53\-13ba # [filter] match by device UUID options: [noexec, nodev] # [action] mount options can be given as list ignore: false # [action] never ignore this device (even if fs=FAT) automount: false # [action] do not automount this device \- id_type: vfat # [filter] match file system type ignore: true # [action] ignore all FAT devices \- ignore: True # never mount/unmount or even show this in the GUI automount: False # show but do not automount this device options: [] # additional options to be passed when mounting mount_options: # [deprecated] do not use ignore_device: # [deprecated] do not use notifications: # Customize which notifications are shown for how long\&. Possible # values are: # positive number timeout in seconds # false disable # \-1 use the libnotify default timeout timeout: 1\&.5 # set the default for all notifications # Specify only if you want to overwrite the the default: device_mounted: 5 # mount notification device_unmounted: false # unmount notification device_added: false # device has appeared device_removed: false # device has disappeared device_unlocked: \-1 # encrypted device was unlocked device_locked: \-1 # encrypted device was locked job_failed: \-1 # mount/unlock/\&.\&. has failed notification_actions: # Define which actions should be shown on notifications\&. Note that there # are currently only a limited set of actions available for each # notification\&. Events that are not explicitly specified show the default # set of actions\&. Specify an empty list if you don\*(Aqt want to see any # notification for the specified event: device_mounted: [browse] device_added: [mount] icon_names: # Customize the icon set used by the tray widget\&. Each entry # specifies a list of icon names\&. The first installed icon from # that list will be used\&. media: [drive\-removable\-media, media\-optical] browse: [document\-open, folder\-open] mount: [udiskie\-mount] unmount: [udiskie\-unmount] unlock: [udiskie\-unlock] lock: [udiskie\-lock] eject: [udiskie\-eject, media\-eject] detach: [udiskie\-detach] delete: [udiskie\-eject] quit: [application\-exit] .fi .if n \{\ .RE .\} .sp All keys are optional\&. Reasonable defaults are used if you leave them unspecified\&. .SH "DEVICE ATTRIBUTES" .sp Some of the config entries make use of Device attributes\&. The following list of attributes is currently available, but there is no guarantee that they will remain available: .sp .if n \{\ .RS 4 .\} .nf Attribute Hint/Example .fi .if n \{\ .RE .\} .sp .if n \{\ .RS 4 .\} .nf is_drive is_block is_partition_table is_partition is_filesystem is_luks is_loop is_toplevel is_detachable is_ejectable has_media device_file block device path, e\&.g\&. "/dev/sdb1" device_presentation display string, e\&.g\&. "/dev/sdb1" device_id unique, persistent device identifier id_usage E\&.g\&. "filesystem" or "crypto" is_crypto is_ignored id_type E\&.g\&. "ext4" or "crypto_LUKS" id_label device label id_uuid device UUID is_luks_cleartext is_external udisks flag HintSystem=false is_systeminternal udisks flag HintSystem=true is_mounted mount_paths list of mount paths mount_path any mount path is_unlocked in_use device or any of its children mounted should_automount ui_label loop_file file backing the loop device setup_by_uid user that setup the loop device autoclear automatically delete loop device after use symlinks drive_model drive_vendor drive_label ui_device_label ui_device_presentation ui_id_label ui_id_uuid .fi .if n \{\ .RE .\} .SH "SEE ALSO" .sp \fBudisks\fR(1) .sp http://www\&.freedesktop\&.org/wiki/Software/udisks/ .SH "CONTACT" .sp You can use the github issues to report any issues you encounter, ask general questions or suggest new features\&. If you don\(cqt have or like github, you can contact me by email: .sp https://github\&.com/coldfix/udiskie/issues .sp thomas@coldfix\&.de