dotfiles

my shiny new dotfiles
git clone git://git.jakekoroman.com/dotfiles
Log | Files | Refs | README

dwlb.1 (5283B)


      1 .TH DWLB 1 2023 Linux "User's Reference Manuals"
      2 .
      3 .SH NAME
      4 dwlb \- feature-complete bar for dwl
      5 .
      6 .SH SYNOPSIS
      7 .
      8 .SY dwlb
      9 .RI [ OPTIONS\~ \&.\|.\|.\&]
     10 .YS
     11 .
     12 .SH DESCRIPTION
     13 .
     14 .B dwlb
     15 is a feature-complete status bar for
     16 .IR dwl .
     17 .
     18 .SH USAGE
     19 .
     20 Pass
     21 .B dwlb
     22 as an argument to
     23 .IR dwl 's
     24 .B -s
     25 flag.
     26 This will populate
     27 each connected output with a bar.
     28 .
     29 .PP
     30 For example:
     31 .IP
     32 .EX
     33 dwl \-s \(aqdwlb \-font "monospace:size=16"\(aq
     34 .EE
     35 .
     36 .SS IPC
     37 .
     38 .PP
     39 If
     40 .I dwl
     41 is patched appropriately,
     42 .B dwlb
     43 is capable of communicating directly with
     44 .IR dwl .
     45 When IPC is enabled with
     46 .BR \-ipc ,
     47 .B dwlb
     48 does not read from
     49 .IR stdin ,
     50 and clicking tags functions as you would expect.
     51 IPC can be disabled with
     52 .BR \-no\-ipc .
     53 .
     54 .SS Commands
     55 .
     56 Command options send instructions
     57 to existing instances of
     58 .BR dwlb .
     59 All commands take at least one argument
     60 to specify a bar on which to operate.
     61 This may be
     62 .I zxdg_output_v1
     63 name,
     64 "all" to affect all outputs,
     65 or "selected" for the current output.
     66 .
     67 .PP
     68 The
     69 .B \-status
     70 and
     71 .B \-title
     72 commands are used to write status text.
     73 The text may contain in-line commands
     74 in the following format:
     75 .IR \(hacmd(argument) .
     76 .
     77 .TP
     78 .BR \(hafg \c
     79 .BI ( HEXCOLOR )
     80 Sets foreground color to
     81 .IR HEXCOLOR .
     82 .TP
     83 .BR \(habg \c
     84 .BI ( HEXCOLOR )
     85 Sets background color to
     86 .IR HEXCOLOR .
     87 .TP
     88 .BR \(halm \c
     89 .BI ( SHELLCOMMAND )
     90 Begins or terminates left mouse button region with action
     91 .IR SHELLCOMMAND .
     92 .TP
     93 .BR \(hamm \c
     94 .BI ( SHELLCOMMAND )
     95 Begins or terminates middle mouse button region with action
     96 .IR SHELLCOMMAND .
     97 .TP
     98 .BR \(harm \c
     99 .BI ( SHELLCOMMAND )
    100 Begins or terminates right mouse button region with action
    101 .IR SHELLCOMMAND .
    102 .
    103 .PP
    104 In this example,
    105 clicking the text highlighted in red
    106 will spawn the foot terminal.
    107 .
    108 .IP
    109 .EX
    110 dwlb \-status all \(aqtext \(habg(ff0000)\(halm(foot)text\(habg()\(halm() text\(aq
    111 .EE
    112 .
    113 .PP
    114 A color command with no argument reverts to the default value.
    115 .B \(ha\(ha
    116 represents a single
    117 .B \(ha
    118 character.
    119 Status commands can be disabled with
    120 .BR \-no\-status\-commands .
    121 .
    122 .SS Scaling
    123 .
    124 .PP
    125 If you use scaling in Wayland,
    126 you can specify
    127 .B buffer_scale
    128 through config file or by passing it as an option
    129 (only integer values):
    130 .
    131 .IP
    132 .EX
    133 dwlb \-scale 2
    134 .EE
    135 .
    136 .PP
    137 This will render both surface and a cursor with 2\(mu detail.
    138 If your monitor is set to 1.25 or 1.5 scaling,
    139 setting scale to 2 will also work as compositor
    140 will downscale the buffer properly.
    141 .
    142 .SS Someblocks
    143 .
    144 .PP
    145 To use
    146 .IR someblocks ,
    147 or any program that outputs to
    148 .IR stdout ,
    149 with
    150 .BR dwlb ,
    151 use this one-liner:
    152 .
    153 .IP
    154 .EX
    155 someblocks \-p | dwlb \-status\-stdin all
    156 .EE
    157 .
    158 .SH OPTIONS
    159 .
    160 .SS IPC
    161 .
    162 .TP
    163 .B \-ipc
    164 Allow commands to be sent to
    165 .I dwl
    166 .RI ( dwl
    167 Must be patched)
    168 .TP
    169 .B \-no\-ipc
    170 Disable ipc
    171 .
    172 .SS Configuration
    173 .
    174 .TP
    175 .B \-hidden
    176 Bars will initially be hidden
    177 .TP
    178 .B \-no\-hidden
    179 Bars will not initially be hidden
    180 .TP
    181 .B \-bottom
    182 Bars will initially be drawn at the bottom
    183 .TP
    184 .B \-no\-bottom
    185 Bars will initially be drawn at the top
    186 .TP
    187 .B \-hide\-vacant\-tags
    188 Do not display empty and inactive tags
    189 .TP
    190 .B \-no\-hide\-vacant\-tags
    191 Display empty and inactive tags
    192 .TP
    193 .B \-status\-commands
    194 Enable in-line commands in status text
    195 .TP
    196 .B \-no\-status\-commands
    197 Disable in-line commands in status text
    198 .TP
    199 .B \-center\-title
    200 Center title text on bar
    201 .TP
    202 .B \-no\-center\-title
    203 Do not center title text on bar
    204 .TP
    205 .B \-custom\-title
    206 Do not display window title and
    207 Treat the area as another status text element;
    208 see
    209 .B \-title
    210 command
    211 .TP
    212 .B \-no\-custom\-title
    213 Display current window title as normal
    214 .TP
    215 .BR \-font \~\c
    216 .I FONT
    217 Specify a font
    218 .TP
    219 .BR \-tags \~\c
    220 .IR NUMBER \~\c
    221 .IR FIRST \&.\|.\|.\& LAST
    222 If ipc is disabled, specify custom tag names
    223 .TP
    224 .BR \-vertical\-padding \~\c
    225 .I PIXELS
    226 Specify vertical pixel padding above and below text
    227 .TP
    228 .BR \-active\-fg\-color \~\c
    229 .I COLOR
    230 Specify text color of active tags or monitors
    231 .TP
    232 .BR \-active\-bg\-color \~\c
    233 .I COLOR
    234 Specify background color of active tags or monitors
    235 .TP
    236 .BR \-occupied\-fg\-color \~\c
    237 .I COLOR
    238 Specify text color of occupied tags
    239 .TP
    240 .BR \-occupied\-bg\-color \~\c
    241 .I COLOR
    242 Specify background color of occupied tags
    243 .TP
    244 .BR \-inactive\-fg\-color \~\c
    245 .I COLOR
    246 Specify text color of inactive tags or monitors
    247 .TP
    248 .BR \-inactive\-bg\-color \~\c
    249 .I COLOR
    250 Specify background color of inactive tags or monitors
    251 .TP
    252 .BR \-urgent\-fg\-color \~\c
    253 .I COLOR
    254 Specify text color of urgent tags
    255 .TP
    256 .BR \-urgent\-bg\-color \~\c
    257 .I COLOR
    258 Specify background color of urgent tags
    259 .TP
    260 .BR \-scale \~\c
    261 .I BUFFER_SCALE
    262 Specify buffer scale value for integer scaling
    263 .
    264 .SS Commands
    265 .
    266 .TP
    267 .BR \-status \~\c
    268 .I OUTPUT\~TEXT
    269 Set status text
    270 .TP
    271 .BR \-status\-stdin \~\c
    272 .I OUTPUT
    273 Set status text from stdin
    274 .TP
    275 .BR \-title \~\c
    276 .I OUTPUT\~TEXT
    277 Set title text,
    278 if
    279 .B \-custom\-title
    280 Is enabled
    281 .TP
    282 .BR \-show \~\c
    283 .I OUTPUT
    284 Show bar
    285 .TP
    286 .BR \-hide \~\c
    287 .I OUTPUT
    288 Hide bar
    289 .TP
    290 .BR \-toggle\-visibility \~\c
    291 .I OUTPUT
    292 Toggle bar visibility
    293 .TP
    294 .BR \-set\-top \~\c
    295 .I OUTPUT
    296 Draw bar at the top
    297 .TP
    298 .BR \-set\-bottom \~\c
    299 .I OUTPUT
    300 Draw bar at the bottom
    301 .TP
    302 .BR \-toggle\-location \~\c
    303 .I OUTPUT
    304 Toggle bar location
    305 .
    306 .SS Others
    307 .
    308 .TP
    309 .B \-v
    310 Get version information
    311 .TP
    312 .B \-h
    313 View this help text
    314 .
    315 .SH SEE ALSO
    316 .
    317 .BR dwl (1),
    318 .BR someblocks (1)
    319 .
    320 .SH AUTHOR
    321 .
    322 .UR https://\:github\:.com/\:kolunmi
    323 kolumni
    324 .UE