.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar-modules-removables" "5" "2022-12-17"
.P
.SH NAME
removables - This module detects removable drives
.P
.SH DESCRIPTION
.P
This module detects removable drives (USB sticks, CD-ROMs) and
instantiates the provided \fIcontent\fR particle for each detected drive.\&
.P
.SH TAGS
.P
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
vendor
T}	T{
string
T}	T{
Name of the drive vendor
T}
T{
model
T}	T{
string
T}	T{
Drive model name
T}
T{
optical
T}	T{
bool
T}	T{
True if the drive is an optical drive (CD-ROM, DVD-ROM etc)
T}
T{
audio
T}	T{
bool
T}	T{
True if an optical drive has an audio CD inserted (i.\&e.\& this property is always false for non-optical drives).\&
T}
T{
device
T}	T{
string
T}	T{
Volume device name (typically \fB/dev/sd?\&\fR)
T}
T{
size
T}	T{
range
T}	T{
The volume'\&s size, in bytes.\& The tag'\&s maximum value is set to the underlying block device'\&s size
T}
T{
label
T}	T{
string
T}	T{
The volume'\&s label, or its size if it has no label
T}
T{
mounted
T}	T{
bool
T}	T{
True if the volume is mounted
T}
T{
mount_point
T}	T{
string
T}	T{
Path where the volume is mounted, or \fB""\fR if it is not mounted
T}
.TE
.sp 1
.SH CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
left-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, in the left side of each rendered volume
T}
T{
right-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, on the right side of each rendered volume
T}
T{
spacing
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting both \fIleft-spacing\fR and \fIright-spacing\fR
T}
T{
ignore
T}	T{
list of strings
T}	T{
no
T}	T{
List of device paths that should be ignored (e.\&g.\& /dev/mmcblk0, or /dev/mmcblk0p1)
T}
.TE
.sp 1
.SH EXAMPLES
.P
.nf
.RS 4
bar:
  right:
    - removables:
        content:
          map:
            conditions:
              ~mounted:
                string:
                  on-click: udisksctl mount -b {device}
                  text: "{label}"
              mounted:
                string:
                  on-click: udisksctl unmount -b {device}
                  text: "{label}"
                  deco: {underline: {size: 2, color: ffffffff}}
.fi
.RE
.P
.SH SEE ALSO
.P
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.P