{ "content": [ { "type": "text", "text": "# UDISKS (man)\n\n## NAME\n\nudisks - Disk Manager\n\n## DESCRIPTION\n\nudisks provides interfaces to enumerate and perform operations on disks and storage devices.\nAny application (including unprivileged ones) can access the udisksd(8) daemon via the name\norg.freedesktop.UDisks2 on the system message bus[1]. In addition to the D-Bus API, a\nlibrary, libudisks2 is also provided. This library can be used from C/C++ and any high-level\nlanguage with GObjectIntrospection[2] support such as Javascript and Python. udisks is only\nindirectly involved in what devices and objects are shown in the user interface.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **ACCESS CONTROL**\n- **DRIVE CONFIGURATION** (6 subsections)\n- **DEVICE INFORMATION**\n- **API STABILITY**\n- **AUDIENCE**\n- **AUTHOR**\n- **BUGS**\n- **SEE ALSO**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "UDISKS", "section": "", "mode": "man", "summary": "udisks - Disk Manager", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "udev", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/udev/7/json" }, { "name": "polkit", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/polkit/8/json" }, { "name": "udisksd", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/udisksd/8/json" }, { "name": "udisksctl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/udisksctl/1/json" }, { "name": "umount.udisks2", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/umount.udisks2/8/json" }, { "name": "gnome-disks", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/gnome-disks/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 7, "subsections": [] }, { "name": "ACCESS CONTROL", "lines": 8, "subsections": [] }, { "name": "DRIVE CONFIGURATION", "lines": 9, "subsections": [ { "name": "ATA group", "lines": 3 }, { "name": "StandbyTimeout", "lines": 9 }, { "name": "APMLevel", "lines": 8 }, { "name": "AAMLevel", "lines": 9 }, { "name": "WriteCacheEnabled", "lines": 4 }, { "name": "ReadLookaheadEnabled", "lines": 4 } ] }, { "name": "DEVICE INFORMATION", "lines": 38, "subsections": [] }, { "name": "API STABILITY", "lines": 17, "subsections": [] }, { "name": "AUDIENCE", "lines": 27, "subsections": [] }, { "name": "AUTHOR", "lines": 3, "subsections": [] }, { "name": "BUGS", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "NOTES", "lines": 36, "subsections": [] } ], "sections": { "NAME": { "content": "udisks - Disk Manager\n", "subsections": [] }, "DESCRIPTION": { "content": "udisks provides interfaces to enumerate and perform operations on disks and storage devices.\nAny application (including unprivileged ones) can access the udisksd(8) daemon via the name\norg.freedesktop.UDisks2 on the system message bus[1]. In addition to the D-Bus API, a\nlibrary, libudisks2 is also provided. This library can be used from C/C++ and any high-level\nlanguage with GObjectIntrospection[2] support such as Javascript and Python. udisks is only\nindirectly involved in what devices and objects are shown in the user interface.\n", "subsections": [] }, "ACCESS CONTROL": { "content": "By default, logged-in users in active log-in sessions are permitted to perform operations\n(for example, mounting, unlocking or modifying) on devices attached to the seat their session\nis on. Access-control is fine-grained and based on polkit(8), see the “Authorization Checks”\nchapter in the udisks documentation for more information. Note that the x-udisks-auth option\ncan be used in the /etc/fstab and /etc/crypttab files to specify that additional\nauthorization is required to mount resp. unlock the device (typically requiring the user to\nauthenticate as an administrator).\n", "subsections": [] }, "DRIVE CONFIGURATION": { "content": "At start-up and when a drive is connected, udisksd(8) will apply configuration stored in the\nfile /etc/udisks2/IDENTIFIER.conf where IDENTIFIER is the value of the Drive:Id property for\nthe drive. If the file changes on disk its new contents will also be applied to the drive.\nTypically, users or administrators will never need to edit drive configuration files as they\nare effectively managed through graphical applications such as gnome-disks(1). Manually\nediting configuration files is however supported — the file format is a simple .ini-like\nformat (see the Desktop Entry Specification[3] for the exact syntax). New groups and keys may\nbe added in the future.\n", "subsections": [ { "name": "ATA group", "content": "The ATA group is for settings that apply to drives using the ATA command-set. The following\nkeys are supported:\n" }, { "name": "StandbyTimeout", "content": "The standby timeout. A value of zero means \"timeouts are disabled\": the device will not\nautomatically enter standby mode. Values from 1 to 240 specify multiples of 5 seconds,\nyielding timeouts from 5 seconds to 20 minutes. Values from 241 to 251 specify from 1 to\n11 units of 30 minutes, yielding timeouts from 30 minutes to 5.5 hours. A value of 252\nsignifies a timeout of 21 minutes. A value of 253 sets a vendor-defined timeout period\nbetween 8 and 12 hours, and the value 254 is reserved. 255 is interpreted as 21 minutes\nplus 15 seconds. Note that some older drives may have very different interpretations of\nthese values. This is similar to the -S option in hdparm(8).\n" }, { "name": "APMLevel", "content": "The Advanced Power Management level. A low value means aggressive power management and a\nhigh value means better performance. Possible settings range from values 1 through 127\n(which permit spin-down), and values 128 through 254 (which do not permit spin-down). The\nhighest degree of power management is attained with a setting of 1, and the highest I/O\nperformance with a setting of 254. A value of 255 can be used to disable Advanced Power\nManagement altogether on the drive (not all drives support disabling it, but most do).\nThis is similar to the -B option in hdparm(8).\n" }, { "name": "AAMLevel", "content": "The Automatic Acoustic Management level. Most modern harddisk drives have the ability to\nspeed down the head movements to reduce their noise output. The possible values are\nbetween 0 and 254. 128 is the most quiet (and therefore slowest) setting and 254 the\nfastest (and loudest). Some drives have only two levels (quiet / fast), while others may\nhave different levels between 128 and 254. At the moment, most drives only support 3\noptions, off, quiet, and fast. These have been assigned the values 0, 128, and 254 at\npresent, respectively, but integer space has been incorporated for future expansion,\nshould this change. This is similar to the -M option in hdparm(8).\n" }, { "name": "WriteCacheEnabled", "content": "A boolean specifying whether to enable or disable the Write Cache. Valid values for this\nkey are “true” and “false”. This is similar to the -W option in hdparm(8). This key was\nadded in 2.1.\n" }, { "name": "ReadLookaheadEnabled", "content": "A boolean specifying whether to enable or disable the Read Look-ahead. Valid values for\nthis key are “true” and “false”. This is similar to the -A option in hdparm(8). This key\nwas added in 2.6.0.\n" } ] }, "DEVICE INFORMATION": { "content": "udisks relies on recent versions of udev(7) and the Linux kernel. Influential device\nproperties in the udev database include:\n\nUDISKSSYSTEM\nIf set, this overrides the value of the HintSystem property.\n\nUDISKSIGNORE\nIf set, this overrides the value of the HintIgnore property.\n\nUDISKSAUTO\nIf set, this overrides the value of the HintAuto property.\n\nUDISKSCANPOWEROFF\nIf set, this overrides the value of the CanPowerOff property.\n\nUDISKSNAME\nThe name to use for the device when presenting it in an user interface. This corresponds\nto the HintName property.\n\nUDISKSICONNAME\nThe icon to use for the device when presenting it in an user interface. If set, the name\nmust adhere to the freedesktop.org icon theme specification[4]. This corresponds to the\nHintIconName property.\n\nUDISKSSYMBOLICICONNAME\nThe icon to use for the device when presenting it in an user interface using a symbolic\nicon. If set, the name must adhere to the freedesktop.org icon theme specification[4].\nThis corresponds to the HintSymbolicIconName property.\n\nUDISKSFILESYSTEMSHARED\nIf set to 1, the filesystem on the device will be mounted in a shared directory (e.g.\n/media/VolumeName) instead of a private directory (e.g. /run/media/$USER/VolumeName)\nwhen the Filesystem.Mount() method is handled.\n\nIDSEAT\nThe physical seat the device is attached to. If unset or set to the empty string, “seat0”\n(the first seat) is assumed.\n", "subsections": [] }, "API STABILITY": { "content": "udisks guarantees a stable D-Bus API within the same major version and this guarantee also\nextends to the client-side library libudisks2. Additionally, several major versions of udisks\ncan be installed and operate at the same time although interoperability may be limited - for\nexample, a device mounted using the udisks N.x API may require additional authorization if\nattempting to unmount it through the the (N-1).x API.\n\nThe udisks developers do not anticipate breaking API but does reserve the right to do so and\nif it happens, promises to bump the major version and ensure the new major version of udisks\nis parallel-installable with any older major version. However, note that programs, man pages\nand other artifacts may change name (for example, adopt a “2” suffix) to make room for the\nnext major version. Therefore, applications can not rely on tools like e.g. udisksctl(1) to\nbe available. Additionally, there is no guarantee that the options, command-line switches\netc. of command-line tools or similar will remain stable.\n\nInstead, applications should only use the D-Bus API, the libudisks2 library or tools such as\ndbus-send(1) or gdbus(1) to interact with udisksd(8).\n", "subsections": [] }, "AUDIENCE": { "content": "The intended audience of udisks include operating system developers working on the\nhigher-level parts of the operating system, for example the desktop shell (such as GNOME[5])\nand disk management applications (e.g. GNOME's Disks[6] application). Software on this level\ntypically depend on a specific (major) version of udisks and may even have support for\nprevious versions of udisks or alternative interfaces performing the same role as udisks.\n\nWhile udisks indeed provides a stable API and a clear upgrade path, it may not be an\nappropriate dependency for third party applications. For example, if the operating system\nswitches to udisks version N.x and an application is still using the udisks (N-1).x API, the\napplication will not work unless udisks (N-1).x is installed. While this situation is still\nworkable (since both udisks N.x and udisks (N-1).x can be installed) it may not be desirable\nto ask the user to install the old version - in fact, the operating system vendor may not\neven provide a packaged version of the old version. Hence, if an application does not want to\ntie itself to a specific version of the operating system, it should not use udisks.\n\nViable alternatives to udisks are APIs that are guaranteed to be around for longer\ntime-frames, including:\n\n• Low-level APIs and commands such as e.g. sysfs[7], libudev[8], /proc/self/mountinfo[9]\nand util-linux[10].\n\n• High-level APIs such as GVolumeMonitor[11].\n\nIn particular, for desktop applications it is a much better idea to use something like\nGVolumeMonitor since it will make the application show the same devices as the desktop shell\n(e.g. file manager, file chooser and so on) is showing.\n", "subsections": [] }, "AUTHOR": { "content": "This man page was originally written for UDisks2 by David Zeuthen with a\nlot of help from many others.\n", "subsections": [] }, "BUGS": { "content": "Please send bug reports to either the distribution bug tracker or the upstream bug tracker at\nhttps://github.com/storaged-project/udisks/issues.\n", "subsections": [] }, "SEE ALSO": { "content": "udev(7), polkit(8), udisksd(8), udisksctl(1), umount.udisks2(8), gnome-disks(1)\n", "subsections": [] }, "NOTES": { "content": "1. system message bus\nhttp://www.freedesktop.org/wiki/Software/dbus\n\n2. GObjectIntrospection\nhttps://live.gnome.org/GObjectIntrospection\n\n3. Desktop Entry Specification\nhttp://freedesktop.org/wiki/Specifications/desktop-entry-spec\n\n4. freedesktop.org icon theme specification\nhttp://www.freedesktop.org/wiki/Specifications/icon-theme-spec\n\n5. GNOME\nhttp://www.gnome.org\n\n6. Disks\nhttps://live.gnome.org/Design/Apps/Disks\n\n7. sysfs\nhttp://en.wikipedia.org/wiki/Sysfs\n\n8. libudev\nhttps://www.freedesktop.org/software/systemd/man/libudev.html\n\n9. /proc/self/mountinfo\nhttp://www.kernel.org/doc/Documentation/filesystems/proc.txt\n\n10. util-linux\nhttp://en.wikipedia.org/wiki/Util-linux\n\n11. GVolumeMonitor\nhttp://developer.gnome.org/gio/stable/volumemon.html\n\n\n\nudisks 2.9.4 August 2018 UDISKS(8)", "subsections": [] } } } }