From: David Zeuthen Date: Mon, 25 Oct 2010 18:47:59 +0000 (-0400) Subject: Update udisks(1) man page X-Git-Tag: upstream/2.1.2~480^2~174 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=99241faaf16eac93e0f315594f7fc6129ebffacd;p=platform%2Fupstream%2Fudisks2.git Update udisks(1) man page Signed-off-by: David Zeuthen --- diff --git a/doc/man/udisks.xml b/doc/man/udisks.xml index cd50639..c651c7d 100644 --- a/doc/man/udisks.xml +++ b/doc/man/udisks.xml @@ -19,307 +19,250 @@ udisks - + info + + --object-path OBJECT + --block-device DEVICE + - - - DESCRIPTION - - udisks is a - simple command line client for the - udisks7 - system bus service. - - + + udisks + mount + + --object-path OBJECT + --block-device DEVICE + + + --filesystem-type TYPE + + --option OPTION + - - OPTIONS - - - - - - Dump all information about all devices. Please include this when filing bugs. - - - + + udisks + unmount + + --object-path OBJECT + --block-device DEVICE + + --option OPTION + - - - - - Lists all object paths of devices know to the daemon. - - - + + udisks + monitor + - - - - - Lists all device files of devices know to the daemon. - - - + + udisks + dump + - - - - - Connect to the daemon and print a line every time an event - happens. - - - + + udisks + help + + - - - - - Like but prints the full - details of the device whenever an event happens. - - - + Description + + udisks is a command-line program used + to interact with the udisks daemon. + - - - - device_file - - - - Shows information about device_file. - - - + + Commands + - - - - device_file - - - - - Inhibits polling on device_file. If no program is given, - polling is inhibited until Ctrl+C is pressed. Otherwise the program is spawned and the polling - is only inhibited until the program terminates. - - - + + + + + Mounts a device. The device will be mounted in a + subdirectory in the /media + hierarchy - upon successful completion, the mount point + will be printed to standard output. + + + The device will be mounted with a safe set of default + options. You can influence the options passed to the + mount8 + command with + --option - do not use a comma to + separate options into one word - instead simply use the + option several times. Note that only safe options are + allowed - requests with inherently unsafe options such + as suid or + dev that would allow the caller + to gain additional privileges, are rejected. + + + The special option + auth_no_user_interaction can + be used to request that no interaction (such as the user + being presented with an authentication dialog) must + occur when checking with + polkit8 + whether the caller is authorized to perform the + requested action. + + + - - - - device_file - - - - Polls device_file to perform media detection. - - - + + + + + Unmounts a device previously mounted with udisks. The + special option force can be used + to request that the device is unmounted even if active + references exists. + + + - - - - - - - - Inhibits polling on all devices. If no program is given, - polling is inhibited until Ctrl+C is pressed. Otherwise the program is spawned and the polling - is only inhibited until the program terminates. - - - + + + + Monitors the daemon for events. + + - - - - device_file - fstype - options - - - - Mounts the device represented by device_file using - the file system fstype and a comma-separated list - of options. - - - + + + + Prints the current state of the daemon. + + - - - - device_file - options - - - - Unmounts the device represented by device_file using - a comma-separated list of options. - - - + + + + Prints help and exit. + + - - - - device_file - options - - - - Detaches (e.g. powering down the physical port the device - is connected to) the device represented - by device_file using a - comma-separated list - of options. - - - + + - - - - device_file - - - - - Refreshes ATA SMART data for device_file. If the disk is - sleeping it will not be woken up unless is passed. - will be used. - - - + - - - - device_file - blob - - - - Read ATA SMART data from blob for device_file. - This can only be done by the super user and is typically used for testing that clients - relying on the ATA SMART data provided by udisks behave correctly. - The libatasmart git repository at - - contains a collection of blobs from failing disks. - - - + Audience + + This program does not assume that the caller is the super user - + it is intended to be used by unprivileged users and + authorizations are checked by the udisks daemon using + polkit8. + Additionally, this program is not intended to be used by scripts + or other programs - options/commands may change in incompatible + ways in the future even in maintenance releases. Scripts and/or + other programs should either use the D-Bus APIs of + udisks-daemon8 + or native low-level commands such as + mount8. + + - - - - - - - - Inhibits clients from invoking methods on the daemon that - require authorization (all methods will return the - org.freedesktop.UDisks.Error.Inhibited error) if - the caller is not the super user. This is typically used - by OS installers and other programs that expects full - control of the system, specifically to avoid automounting - devices. Only the super user can do this. - - - If no program is given, the daemon is inhibited until - Ctrl+C is pressed. Otherwise the program is spawned and - the daemon is only inhibited until the program terminates. - - - + Bash completion + + udisks ships with a bash completion script to + complete commands, objects, block devices and some options. + + - - - - device_file - - seconds - - - - - Configures disk spindown timeout on device_file to - seconds. - See for important information before using this option. - - - If no program is given, the spindown time will be used until Ctrl+C is pressed. Otherwise the program is - spawned and the the spindown timeout will only be used until the program terminates. - - - + + Examples - - - - - seconds - - - - - Configures disk spindown timeout on all disks that can be spun down to seconds. - See for important information before using this option. - - - If no program is given, the spindown time will be used until Ctrl+C is pressed. Otherwise the program is - spawned and the the spindown timeout will only be used until the program terminates. - - - + + Mounting and unmounting devices: + + +$ udisks mount --block-device /dev/mmcblk0p2 +Mounted /dev/mmcblk0p2 at /media/stuff - - - - - Show help options. - - - - - +$ udisks unmount --block-device /dev/mmcblk0p2 +Unmounted /dev/mmcblk0p2 + - SPINNING DOWN DISKS - Caution should be exercised when configuring disk spin down timeouts. + Mounting with non-standard options: + +$ udisks mount --block-device /dev/mmcblk0p2 --option flush --option utf8=0 --option iocharset=iso8859-15 +Mounted /dev/mmcblk0p2 at /media/stuff + +$ udisks mount --block-device /dev/mmcblk0p2 --option suid +Error mounting /dev/mmcblk0p2: GDBus.Error:org.freedesktop.UDisks.Error.Failed: Mount option `suid' is not allowed + + - Note that every time a disk is spun down, - the start-stop-count ATA SMART attribute will - increase by 1 and most disks are only good for a limited number - (typically 50,000 but it varies by manufacturer and model). In - addition, the drive may take as long as 30 seconds to respond to - subsequent disk access – most drives are typically faster, see - the spin-up-time ATA SMART attribute. + Showing information about a device: + +$ udisks info --block-device /dev/mmcblk0p2 +/org/freedesktop/UDisks/devices/mmcblk0p2: + org.freedesktop.UDisks.BlockDevice: + Device: /dev/mmcblk0p2 + Major: 179 + Minor: 2 + Size: 15794176 + Symlinks: /dev/block/179:2 + /dev/disk/by-id/mmc-SD01G_0x50882907-part2 + /dev/disk/by-path/pci-0000:05:00.2-part2 + /dev/disk/by-uuid/6DA7-F983 + /dev/disk/by-label/stuff\x22 + org.freedesktop.UDisks.BlockDevice.Probed: + Label: stuff" + Type: vfat + UUID: 6DA7-F983 + Usage: filesystem + Version: FAT16 + org.freedesktop.UDisks.Filesystem: + MountPoints: + org.freedesktop.UDisks.LinuxSysfsDevice: + Subsystem: block + SysfsPath: /sys/devices/pci0000:00/0000:00:1e.0/0000:05:00.2/mmc_host/mmc0/mmc0:9ffc/block/mmcblk0/mmcblk0p2 + - On the other hand, cautious use (e.g. using conservative - timeouts) of the ability to spin down disks, can be a good way - to trade power consumption (typically 8 vs 1 Watts for 3.5" - drives) and heat emission for a slightly higher latency. + Monitoring the daemon: + +$ udisks monitor +Monitoring the udisks daemon. Press Ctrl+C to exit. +14:33:21.363: The udisks-daemon is running (name-owner :1.1254). + +14:33:27.616: Added /org/freedesktop/UDisks/jobs/10 + org.freedesktop.UDisks.Job: + ExpectedEndTime: 0 + Progress: 0.0 + StartTime: 0 +14:33:27.663: /org/freedesktop/UDisks/devices/mmcblk0p2: org.freedesktop.UDisks.Filesystem: Properties Changed + MountPoints: /media/stuff" +14:33:27.663: /org/freedesktop/UDisks/jobs/10: org.freedesktop.UDisks.Job::Completed (true, '') +14:33:27.664: Removed /org/freedesktop/UDisks/jobs/10 + +14:33:29.751: Added /org/freedesktop/UDisks/jobs/11 + org.freedesktop.UDisks.Job: + ExpectedEndTime: 0 + Progress: 0.0 + StartTime: 0 +14:33:29.752: /org/freedesktop/UDisks/devices/mmcblk0p2: org.freedesktop.UDisks.Filesystem: Properties Changed + MountPoints: +14:33:29.759: /org/freedesktop/UDisks/jobs/11: org.freedesktop.UDisks.Job::Completed (true, '') +14:33:29.759: Removed /org/freedesktop/UDisks/jobs/11 + - AUTHOR + Author - Written by David Zeuthen david@fubar.dk with + Written by David Zeuthen zeuthen@gmail.com with a lot of help from many others. - BUGS + Bugs Please send bug reports to either the distribution bug tracker or the upstream bug tracker at @@ -328,7 +271,7 @@ - SEE ALSO + See also udisks-daemon8