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 vendor                       │
17       ├────────────┼────────┼────────────────────────────────────────────────┤
18       │model       │ string │ Drive model name                               │
19       ├────────────┼────────┼────────────────────────────────────────────────┤
20       │optical     │ bool   │ True if the drive is an optical drive (CD-ROM, │
21       │            │        │ DVD-ROM etc)                                   │
22       ├────────────┼────────┼────────────────────────────────────────────────┤
23       │audio       │ bool   │ True if an optical drive has an audio CD in‐   │
24       │            │        │ serted (i.e. this property is always false for │
25       │            │        │ non-optical drives).                           │
26       ├────────────┼────────┼────────────────────────────────────────────────┤
27       │device      │ string │ Volume device name (typically /dev/sd?)        │
28       ├────────────┼────────┼────────────────────────────────────────────────┤
29       │size        │ range  │ The volume's size, in bytes. The tag's maximum │
30       │            │        │ value is set to the underlying block device's  │
31       │            │        │ size                                           │
32       ├────────────┼────────┼────────────────────────────────────────────────┤
33       │label       │ string │ The volume's label, or its size if it has no   │
34       │            │        │ label                                          │
35       ├────────────┼────────┼────────────────────────────────────────────────┤
36       │mounted     │ bool   │ True if the volume is mounted                  │
37       ├────────────┼────────┼────────────────────────────────────────────────┤
38       │mount_point │ string │ Path where the volume is mounted, or "" if it  │
39       │            │        │ is not mounted                                 │
40       └────────────┴────────┴────────────────────────────────────────────────┘
41

CONFIGURATION

43       ┌──────────────┬─────────────────┬─────┬───────────────────────────────┐
44Name          Type            Req Description                   
45       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
46       │left-spacing  │ int             │ no  │ Space, in pixels, in the left │
47       │              │                 │     │ side of each rendered volume  │
48       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
49       │right-spacing │ int             │ no  │ Space, in pixels, on the      │
50       │              │                 │     │ right side of each rendered   │
51       │              │                 │     │ volume                        │
52       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
53       │spacing       │ int             │ no  │ Short-hand for setting both   │
54       │              │                 │     │ left-spacing and right-spac‐
55       │              │                 │     │ ing
56       ├──────────────┼─────────────────┼─────┼───────────────────────────────┤
57       │ignore        │ list of strings │ no  │ List of device paths that     │
58       │              │                 │     │ should be ignored (e.g.       │
59       │              │                 │     │ /dev/mmcblk0, or /dev/mm‐     │
60       │              │                 │     │ cblk0p1)                      │
61       └──────────────┴─────────────────┴─────┴───────────────────────────────┘
62

EXAMPLES

64           bar:
65             right:
66               - removables:
67                   content:
68                     map:
69                       conditions:
70                         ~mounted:
71                           string:
72                             on-click: udisksctl mount -b {device}
73                             text: "{label}"
74                         mounted:
75                           string:
76                             on-click: udisksctl unmount -b {device}
77                             text: "{label}"
78                             deco: {underline: {size: 2, color: ffffffff}}
79

SEE ALSO

81       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
82       tions(5)
83
84                                  2023-07-22      yambar-modules-removables(5)
Impressum