# losetup(8) - man - phpman

> **TLDR:** Set up and control loop devices.
>
- List loop devices with detailed info:
  `losetup {{-a|--all}}`
- Attach a file to a given loop device:
  `sudo losetup {{/dev/loop}} /{{path/to/file}}`
- Attach a file to a new free loop device and scan the device for partitions:
  `sudo losetup --show {{-P|--partscan}} {{-f|--find}} /{{path/to/file}}`
- Attach a file to a read-only loop device:
  `sudo losetup {{-r|--read-only}} {{/dev/loop}} /{{path/to/file}}`
- Detach all loop devices:
  `sudo losetup {{-D|--detach-all}}`
- Detach a given loop device:
  `sudo losetup {{-d|--detach}} {{/dev/loop}}`

*Source: tldr-pages*

---

[LOSETUP(8)](https://www.chedong.com/phpMan.php/man/LOSETUP/8/markdown)                              System Administration                             [LOSETUP(8)](https://www.chedong.com/phpMan.php/man/LOSETUP/8/markdown)



## NAME
       losetup - set up and control loop devices

## SYNOPSIS
       Get info:

       **losetup** [_loopdev_]

       **losetup** **-l** [**-a**]

       **losetup** **-j** _file_ [**-o** _offset_]

       Detach a loop device:

       **losetup** **-d** _loopdev_ ...

       Detach all associated loop devices:

### losetup -D

       Set up a loop device:

       **losetup** [**-o** _offset_] [**--sizelimit** _size_] [**--sector-size** _size_] [**-Pr**] [**--show**] **-f** _loopdev_ _file_

       Resize a loop device:

       **losetup** **-c** _loopdev_

## DESCRIPTION
       **losetup** is used to associate loop devices with regular files or block devices, to detach loop
       devices, and to query the status of a loop device. If only the _loopdev_ argument is given, the
       status of the corresponding loop device is shown. If no option is given, all loop devices are
       shown.

       Note that the old output format (i.e., **losetup** **-a**) with comma-delimited strings is deprecated
       in favour of the **--list** output format.

       It’s possible to create more independent loop devices for the same backing file. **This** **setup**
       **may** **be** **dangerous,** **can** **cause** **data** **loss,** **corruption** **and** **overwrites.** Use **--nooverlap** with **--find**
       during setup to avoid this problem.

       The loop device setup is not an atomic operation when used with **--find**, and **losetup** does not
       protect this operation by any lock. The number of attempts is internally restricted to a
       maximum of 16. It is recommended to use for example flock1 to avoid a collision in heavily
       parallel use cases.

## OPTIONS
       The _size_ and _offset_ arguments may be followed by the multiplicative suffixes KiB (=1024), MiB
       (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K"
       has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB,
       TB, PB, EB, ZB and YB.

### -a --all
           Show the status of all loop devices. Note that not all information is accessible for
           non-root users. See also **--list**. The old output format (as printed without **--list)** is
           deprecated.

### -d --detach
           Detach the file or device associated with the specified loop device(s). Note that since
           Linux v3.7 kernel uses "lazy device destruction". The detach operation does not return
           **EBUSY** error anymore if device is actively used by system, but it is marked by autoclear
           flag and destroyed later.

### -D --detach-all
           Detach all associated loop devices.

### -f --find
           Find the first unused loop device. If a _file_ argument is present, use the found device as
           loop device. Otherwise, just print its name.

### --show
           Display the name of the assigned loop device if the **-f** option and a _file_ argument are
           present.

### -L --nooverlap
           Check for conflicts between loop devices to avoid situation when the same backing file is
           shared between more loop devices. If the file is already used by another device then
           re-use the device rather than a new one. The option makes sense only with **--find**.

### -j --associated -o
           Show the status of all loop devices associated with the given _file_.

### -o --offset
           The data start is moved _offset_ bytes into the specified file or device. The _offset_ may be
           followed by the multiplicative suffixes; see above.

       **--sizelimit** _size_
           The data end is set to no more than _size_ bytes after the data start. The _size_ may be
           followed by the multiplicative suffixes; see above.

### -b --sector-size
           Set the logical sector size of the loop device in bytes (since Linux 4.14). The option
           may be used when create a new loop device as well as stand-alone command to modify sector
           size of the already existing loop device.

### -c --set-capacity
           Force the loop driver to reread the size of the file associated with the specified loop
           device.

### -P --partscan
           Force the kernel to scan the partition table on a newly created loop device. Note that
           the partition table parsing depends on sector sizes. The default is sector size is 512
           bytes, otherwise you need to use the option **--sector-size** together with **--partscan**.

### -r --read-only
           Set up a read-only loop device.

       **--direct-io**[**=on**|**off**]
           Enable or disable direct I/O for the backing file. The optional argument can be either **on**
           or **off**. If the argument is omitted, it defaults to **off**.

### -v --verbose
           Verbose mode.

### -l --list
           If a loop device or the **-a** option is specified, print the default columns for either the
           specified loop device or all loop devices; the default is to print info about all
           devices. See also **--output**, **--noheadings**, **--raw**, and **--json**.

### -O --output
           Specify the columns that are to be printed for the **--list** output. Use **--help** to get a
           list of all supported columns.

### --output-all
           Output all available columns.

### -n --noheadings
           Don’t print headings for **--list** output format.

### --raw
           Use the raw **--list** output format.

### -J --json
           Use JSON format for **--list** output.

### -V --version
           Display version information and exit.

### -h --help
           Display help text and exit.

## ENCRYPTION
       **Cryptoloop** **is** **no** **longer** **supported** **in** **favor** **of** **dm-crypt.** For more details see [**cryptsetup**(8)](https://www.chedong.com/phpMan.php/man/cryptsetup/8/markdown).

## EXIT STATUS
       **losetup** returns 0 on success, nonzero on failure. When **losetup** displays the status of a loop
       device, it returns 1 if the device is not configured and 2 if an error occurred which
       prevented determining the status of the device.

## NOTES
       Since version 2.37 **losetup** uses **LOOP**___**CONFIGURE** ioctl to setup a new loop device by one ioctl
       call. The old versions use **LOOP**___**SET**___**FD** and **LOOP**___**SET**___**STATUS64** ioctls to do the same.

## ENVIRONMENT
       LOOPDEV_DEBUG=all
           enables debug output.

## FILES
       _/dev/loop[0..N]_
           loop block devices

       _/dev/loop-control_
           loop control device

## EXAMPLE
       The following commands can be used as an example of using the loop device.

           # dd if=/dev/zero of=~/file.img bs=1024k count=10
           # losetup --find --show ~/file.img
           /dev/loop0
           # mkfs -t ext2 /dev/loop0
           # mount /dev/loop0 /mnt
           ...
           # umount /dev/loop0
           # losetup --detach /dev/loop0

## AUTHORS
       Karel Zak <<kzak@redhat.com>>, based on the original version from Theodore Ts’o
       <<tytso@athena.mit.edu>>.

## REPORTING BUGS
       For bug reports, use the issue tracker at <https://github.com/karelzak/util-linux/issues>.

## AVAILABILITY
       The **losetup** command is part of the util-linux package which can be downloaded from Linux
       Kernel Archive <<https://www.kernel.org/pub/linux/utils/util-linux/>>.



util-linux 2.37.2                            2021-06-02                                   [LOSETUP(8)](https://www.chedong.com/phpMan.php/man/LOSETUP/8/markdown)
