1yambar-modules-removables(5)  File Formats Manual yambar-modules-removables(5)
2
3
4

NAME

6       removables - This module detects removable drives
7

DESCRIPTION

9       This module detects removable drives (USB sticks, CD-ROMs) and instan‐
10       tiates the provided content particle for each detected drive.
11

TAGS

13       ┌────────────┬────────┬─────────────────────┐
14Name        Type   Description         
15       ├────────────┼────────┼─────────────────────┤
16       │vendor      │ string │ Name of the drive   │
17       │            │        │ vendor              │
18       ├────────────┼────────┼─────────────────────┤
19       │model       │ string │ Drive model name    │
20       ├────────────┼────────┼─────────────────────┤
21       │optical     │ bool   │ True if the drive   │
22       │            │        │ is an optical drive │
23       │            │        │ (CD-ROM, DVD-ROM    │
24       │            │        │ etc)                │
25       ├────────────┼────────┼─────────────────────┤
26       │audio       │ bool   │ True if an optical  │
27       │            │        │ drive has an audio  │
28       │            │        │ CD inserted (i.e.   │
29       │            │        │ this property is    │
30       │            │        │ always false for    │
31       │            │        │ non-optical         │
32       │            │        │ drives).            │
33       ├────────────┼────────┼─────────────────────┤
34       │device      │ string │ Volume device name  │
35       │            │        │ (typically          │
36       │            │        │ /dev/sd?)           │
37       ├────────────┼────────┼─────────────────────┤
38       │size        │ range  │ The volume's size,  │
39       │            │        │ in bytes. The tag's │
40       │            │        │ maximum value is    │
41       │            │        │ set to the underly‐ │
42       │            │        │ ing block device's  │
43       │            │        │ size                │
44       ├────────────┼────────┼─────────────────────┤
45       │label       │ string │ The volume's label, │
46       │            │        │ or its size if it   │
47       │            │        │ has no label        │
48       ├────────────┼────────┼─────────────────────┤
49       │mounted     │ bool   │ True if the volume  │
50       │            │        │ is mounted          │
51       ├────────────┼────────┼─────────────────────┤
52       │mount_point │ string │ Path where the vol‐ │
53       │            │        │ ume is mounted, or  │
54       │            │        │ "" if it is not     │
55       │            │        │ mounted             │
56       └────────────┴────────┴─────────────────────┘
57

CONFIGURATION

59       ┌──────────────┬─────────────────┬─────┬──────────────────┐
60Name          Type            Req Description      
61       ├──────────────┼─────────────────┼─────┼──────────────────┤
62       │left-spacing  │ int             │ no  │ Space, in pix‐   │
63       │              │                 │     │ els, in the left │
64       │              │                 │     │ side of each     │
65       │              │                 │     │ rendered volume  │
66       ├──────────────┼─────────────────┼─────┼──────────────────┤
67       │right-spacing │ int             │ no  │ Space, in pix‐   │
68       │              │                 │     │ els, on the      │
69       │              │                 │     │ right side of    │
70       │              │                 │     │ each rendered    │
71       │              │                 │     │ volume           │
72       ├──────────────┼─────────────────┼─────┼──────────────────┤
73       │spacing       │ int             │ no  │ Short-hand for   │
74       │              │                 │     │ setting both     │
75       │              │                 │     │ left-spacing and │
76       │              │                 │     │ right-spacing
77       ├──────────────┼─────────────────┼─────┼──────────────────┤
78       │ignore        │ list of strings │ no  │ List of device   │
79       │              │                 │     │ paths that       │
80       │              │                 │     │ should be ig‐    │
81       │              │                 │     │ nored (e.g.      │
82       │              │                 │     │ /dev/mmcblk0, or │
83       │              │                 │     │ /dev/mmcblk0p1)  │
84       └──────────────┴─────────────────┴─────┴──────────────────┘
85

EXAMPLES

87           bar:
88             right:
89               - removables:
90                   content:
91                     map:
92                       tag: mounted
93                       values:
94                         false:
95                           string:
96                             on-click: udisksctl mount -b {device}
97                             text: "{label}"
98                         true:
99                           string:
100                             on-click: udisksctl unmount -b {device}
101                             text: "{label}"
102                             deco: {underline: {size: 2, color: ffffffff}}
103

SEE ALSO

105       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
106       tions(5)
107
108                                  2022-08-26      yambar-modules-removables(5)
Impressum