diff options
Diffstat (limited to 'mstatus.1')
| -rw-r--r-- | mstatus.1 | 65 |
1 files changed, 43 insertions, 22 deletions
@@ -1,23 +1,37 @@ -.Dd $Mdocdate: 2 August 2021 $ -.Dt MSTATUS 1 URM -.Os DWM +.\" vi: tw=80 +.\" +.\" BSD Zero Clause License +.\" +.\" Copyright (c) 2022 Thomas Voss +.\" +.\" Permission to use, copy, modify, and/or distribute this software for any +.\" purpose with or without fee is hereby granted. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +.\" AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +.\" PERFORMANCE OF THIS SOFTWARE. +.Dd $Mdocdate: September 23 2022 $ +.Dt MSTATUS 1 +.Os .Sh NAME .Nm mstatus -.Nd a modular status bar for DWM +.Nd a modular status bar .Sh SYNOPSIS .Nm .Op Fl r .Op Fl s Ar seperator .Sh DESCRIPTION .Nm -is a modular status bar for the -.Xr dwm 1 -window manager. +is a modular status bar. The .Nm -status bar is comprised of a series of blocks which can be programmatically added, removed, and -updated. -These blocks appear side by side on the status bar seperated by a the string +status bar is comprised of a series of blocks which can be programmatically +added, removed, and updated. +These blocks appear side by side on the status bar seperated by the string .Dq " | " , although this can be configured with the .Fl s @@ -47,14 +61,16 @@ then .Nm will attempt to create/update a block instead. .Pp -Next, you can optionally provide a number which represents the block you want to act upon. +Next, you can optionally provide a number which represents the block you want +to act upon. As an example, the command .Dq \-10 signals that you would like to remove block 10 from the status bar. The command .Dq 4 on the other hand signals that you would like to create/update block 4. -If no block number is specified, then the specified action will be executed on block 1. +If no block number is specified, then the specified action will be executed on +block 1. It is important to note that the command .Dq 0 will be ignored as there is no block 0, however the command @@ -63,8 +79,8 @@ is special in that it deletes all the blocks from the status bar. .Pp Finally, after you have provided the optional .Sq \- -flag and have selected the block to act upon, you can provide any string which will be displayed in -the selected block. +flag and have selected the block to act upon, you can provide any string which +will be displayed in the selected block. If the .Sq \- flag was specified then this string will be simply ignored. @@ -96,14 +112,19 @@ Replace the entire status bar with .Ex -std .Sh NOTES .Nm -always allocates enough memory to be able to hold as many blocks as the number of the rightmost -block. -This means that if you created a block in slots 1 and 2, memory will be allocated for 2 blocks, -however if you create a block in slots 1, 2, and 300, then memory will be allocated for 300 blocks. -It is for this reason that you should avoid creating blocks in very high slots without reason. -Luckily if deleting the block in slot 300 from the above example, the memory for slots 3 to 300 will -all be freed. +always allocates enough memory to be able to hold as many blocks as the number +of the rightmost block. +This means that if you created a block in slots 1 and 2, memory will be +allocated for 2 blocks, however if you create a block in slots 1, 2, and 300, +then memory will be allocated for 300 blocks. +It is for this reason that you should avoid creating blocks in very high slots +without reason. +Luckily if deleting the block in slot 300 from the above example, the memory +for slots 3 to 300 will all be freed. .Sh BUGS As of the initial 1.0 version you cannot have a block which begins with a digit. .Sh SEE ALSO -.Xr dwm 1 +.Xr dwm 1 , +.Xr sway 1 +.Sh AUTHORS +.An Thomas Voss Aq Mt thomasvoss@live.com |