.SH "NAME" udisksctl - The udisks command line tool

  .SH "SYNOPSIS"

    .HP u

      udisksctl
       status
    

    .HP u

      udisksctl
       info
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
    

    .HP u

      udisksctl
       mount
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [
         | --filesystem-type TYPE
      ]
       [--options OPTIONS...]
       [--no-user-interaction]
    

    .HP u

      udisksctl
       unmount
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--force]
       [--no-user-interaction]
    

    .HP u

      udisksctl
       unlock
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--no-user-interaction]
    

    .HP u

      udisksctl
       lock
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--no-user-interaction]
    

    .HP u

      udisksctl
       loop-setup
       --file PATH
       [--read-only]
       [--offset OFFSET]
       [--size SIZE]
       [--no-user-interaction]
    

    .HP u

      udisksctl
       loop-delete
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--no-user-interaction]
    

    .HP u

      udisksctl
       power-off
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--no-user-interaction]
    

    .HP u

      udisksctl
       smart-simulate
       --file PATH
       {
         | --object-path OBJECT
         | --block-device DEVICE
      }
       [--no-user-interaction]
    

    .HP u

      udisksctl
       monitor
    

    .HP u

      udisksctl
       dump
    

    .HP u

      udisksctl
       help
    

  .SH "DESCRIPTION"

    .PP udisksctl is a command-line program used to interact with the udisksd(8) daemon process.

  .SH "COMMANDS"

      .PP status

        
        
          Shows high-level information about disk drives and block devices.

        
      .RE

      .PP info

        
        
          Shows detailed information about OBJECT or DEVICE.

        
      .RE

      .PP mount

        
        
          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 mount(8) command with --options. 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.

        
      .RE

      .PP unmount

        
        
          Unmounts a device. This only works if the device is mounted. The option --force can be used to request that the device is unmounted even if active references exists.

        
      .RE

      .PP unlock

        
        
          Unlocks an encrypted device. The passphrase will be requested from the controlling terminal and upon successful completion, the cleartext device will be printed to standard output.

        
      .RE

      .PP lock

        
        
          Locks a device. This only works if the device is a cleartext device backed by a cryptotext device.

        
      .RE

      .PP loop-setup

        
        
          Sets up a loop device backed by FILE.

        
      .RE

      .PP loop-delete

        
        
          Tears down a loop device.

        
      .RE

      .PP power-off

        
        
          Arranges for the drive to be safely removed and powered off. On the OS side this includes ensuring that no process is using the drive, then requesting that in-flight buffers and caches are committed to stable storage. The exact steps for powering off the drive depends on the drive itself and the interconnect used. For drives connected through USB, the effect is that the USB device will be deconfigured followed by disabling the upstream hub port it is connected to.

          Note that as some physical devices contain multiple drives (for example 4-in-1 flash card reader USB devices) powering off one drive may affect other drives. As such there are not a lot of guarantees associated with performing this action. Usually the effect is that the drive disappears as if it was unplugged.

        
      .RE

      .PP smart-simulate

        
        
          Sets SMART data from the libatasmart blob given by FILE - see /usr/share/doc/libatasmart-devel-VERSION/ for blobs shipped with libatasmart. This is a debugging feature used to check that applications act correctly when a disk is failing.

        
      .RE

      .PP monitor

        
        Monitors the daemon for events.

      .RE

      .PP dump

        
        Prints the current state of the daemon.

      .RE

      .PP help

        
        Prints help and exit.

      .RE

    
  

  .SH "COMMON OPTIONS"

    
    .PP The option --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 polkit(8) whether the caller is authorized to perform the requested action.

  

  .SH "AUDIENCE"

    .PP 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 polkit(8). 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. See the “API STABILITY” section of udisks(8) for more information.

  

  .SH "BASH COMPLETION"

    .PP udisksctl ships with a bash completion script to complete commands, objects, block devices and some options.

  

  .SH "AUTHOR"

    .PP Written by David Zeuthen <zeuthen@gmail.com> with a lot of help from many others.

  

  .SH "BUGS"

    
    .PP Please send bug reports to either the distribution bug tracker or the upstream bug tracker at m[blue]http://bugs.freedesktop.org/enter_bug.cgi?product=udisksm[].

  

  .SH "SEE ALSO"

    
    .PP udisks(8), udisksd(8), umount.udisks2(8), polkit(8)