summaryrefslogtreecommitdiffhomepage
path: root/doc/quick-start.org
diff options
context:
space:
mode:
authorjao <jao@gnu.org>2022-07-24 16:12:39 +0100
committerjao <jao@gnu.org>2022-07-24 16:12:39 +0100
commit141e071d0d523a521e0e790efbb57a95854aaaed (patch)
tree884a1392291ceac8c404bdaa6b4d324c054fc390 /doc/quick-start.org
parentac8a9ed723f1fed8d8a7158e135c72e2b92677c5 (diff)
downloadxmobar-141e071d0d523a521e0e790efbb57a95854aaaed.tar.gz
xmobar-141e071d0d523a521e0e790efbb57a95854aaaed.tar.bz2
documentation: header levels re-adjusted
Diffstat (limited to 'doc/quick-start.org')
-rw-r--r--doc/quick-start.org554
1 files changed, 277 insertions, 277 deletions
diff --git a/doc/quick-start.org b/doc/quick-start.org
index a853578..2557295 100644
--- a/doc/quick-start.org
+++ b/doc/quick-start.org
@@ -26,21 +26,21 @@ available [[https://codeberg.org/xmobar/xmobar/src/branch/master/examples/xmobar
#+begin_src shell
Usage: xmobar [OPTION...] [FILE]
Options:
- -h, -? --help This help
- -v --verbose Emit verbose debugging messages
- -r --recompile Force recompilation
- -V --version Show version information
- -f font name --font=font name Font name
- -N font name --add-font=font name Add to the list of additional fonts
- -w class --wmclass=class X11 WM_CLASS property
- -n name --wmname=name X11 WM_NAME property
- -B bg color --bgcolor=bg color The background color. Default black
- -F fg color --fgcolor=fg color The foreground color. Default grey
- -i path --iconroot=path Root directory for icon pattern paths. Default '.'
- -A alpha --alpha=alpha Transparency: 0 is transparent, 255 is opaque. Default: 255
- -o --top Place xmobar at the top of the screen
- -b --bottom Place xmobar at the bottom of the screen
- -d --dock Don't override redirect from WM and function as a dock
+ -h, -? --help This help
+ -v --verbose Emit verbose debugging messages
+ -r --recompile Force recompilation
+ -V --version Show version information
+ -f font name --font=font name Font name
+ -N font name --add-font=font name Add to the list of additional fonts
+ -w class --wmclass=class X11 WM_CLASS property
+ -n name --wmname=name X11 WM_NAME property
+ -B bg color --bgcolor=bg color The background color. Default black
+ -F fg color --fgcolor=fg color The foreground color. Default grey
+ -i path --iconroot=path Root directory for icon pattern paths. Default '.'
+ -A alpha --alpha=alpha Transparency: 0 is transparent, 255 is opaque. Default: 255
+ -o --top Place xmobar at the top of the screen
+ -b --bottom Place xmobar at the bottom of the screen
+ -d --dock Don't override redirect from WM and function as a dock
-a alignsep --alignsep=alignsep Separators for left, center and right text
alignment. Default: '}{'
-s char --sepchar=char Character used to separate commands in
@@ -58,375 +58,375 @@ available [[https://codeberg.org/xmobar/xmobar/src/branch/master/examples/xmobar
:PROPERTIES:
:CUSTOM_ID: configuration-options
:END:
-*** Global options
- Here are all the global configuration options that you can set within
- the =Config= block in your configuration.
+** Global options
+ Here are all the global configuration options that you can set within
+ the =Config= block in your configuration.
- - =font= Name of the font to be used. Use the =xft:= prefix for XFT
- fonts.
+ - =font= Name of the font to be used. Use the =xft:= prefix for XFT
+ fonts.
- - =additionalFonts= Haskell-style list of fonts to be used with the
- =fn=-template. Use the =xft:= prefix for XFT fonts. See also
- =textOffsets= below. For example:
+ - =additionalFonts= Haskell-style list of fonts to be used with the
+ =fn=-template. Use the =xft:= prefix for XFT fonts. See also
+ =textOffsets= below. For example:
- #+begin_src haskell
- additionalFonts = [iconFont, altIconFont]
- #+end_src
+ #+begin_src haskell
+ additionalFonts = [iconFont, altIconFont]
+ #+end_src
- - =bgColor= Background color.
+ - =bgColor= Background color.
- - =fgColor= Default font color.
+ - =fgColor= Default font color.
- - =alpha= The transparency. 0 is transparent, 255 is opaque.
+ - =alpha= The transparency. 0 is transparent, 255 is opaque.
- - =position= Top, TopH, TopP, TopW, TopSize, Bottom, BottomH,
- BottomP, BottomW, BottomSize or Static (with x, y, width and height).
+ - =position= Top, TopH, TopP, TopW, TopSize, Bottom, BottomH,
+ BottomP, BottomW, BottomSize or Static (with x, y, width and height).
- TopP and BottomP take 2 arguments: left padding and right padding.
+ TopP and BottomP take 2 arguments: left padding and right padding.
- TopW and BottomW take 2 arguments: an alignment parameter (L for left,
- C for centered, R for Right) and an integer for the percentage width
- xmobar window will have in respect to the screen width.
+ TopW and BottomW take 2 arguments: an alignment parameter (L for left,
+ C for centered, R for Right) and an integer for the percentage width
+ xmobar window will have in respect to the screen width.
- TopSize and BottomSize take 3 arguments: an alignment parameter, an
- integer for the percentage width, and an integer for the minimum pixel
- height that the xmobar window will have.
+ TopSize and BottomSize take 3 arguments: an alignment parameter, an
+ integer for the percentage width, and an integer for the minimum pixel
+ height that the xmobar window will have.
- TopH and BottomH take one argument (Int) which adjusts the bar height.
+ TopH and BottomH take one argument (Int) which adjusts the bar height.
- For example:
+ For example:
- #+begin_src haskell
- position = TopH 30
- #+end_src
+ #+begin_src haskell
+ position = TopH 30
+ #+end_src
- to make a 30 tall bar on the top, or
+ to make a 30 tall bar on the top, or
- #+begin_src haskell
- position = BottomH 30
- #+end_src
+ #+begin_src haskell
+ position = BottomH 30
+ #+end_src
- to make a 30 tall bar on the bottom of the screen.
+ to make a 30 tall bar on the bottom of the screen.
- #+begin_src haskell
- position = BottomW C 75
- #+end_src
+ #+begin_src haskell
+ position = BottomW C 75
+ #+end_src
- to place xmobar at the bottom, centered with the 75% of the screen
- width. Or
+ to place xmobar at the bottom, centered with the 75% of the screen
+ width. Or
- #+begin_src haskell
- position = BottomP 120 0
- #+end_src
+ #+begin_src haskell
+ position = BottomP 120 0
+ #+end_src
- to place xmobar at the bottom, with 120 pixel indent of the left. Or
+ to place xmobar at the bottom, with 120 pixel indent of the left. Or
- #+begin_src haskell
- position = Static { xpos = 0 , ypos = 0, width = 1024, height = 15 }
- #+end_src
+ #+begin_src haskell
+ position = Static { xpos = 0 , ypos = 0, width = 1024, height = 15 }
+ #+end_src
- or
+ or
- #+begin_src haskell
- position = Top
- #+end_src
+ #+begin_src haskell
+ position = Top
+ #+end_src
- - =textOffset= The vertical offset, in pixels, for the text baseline. If
- negative or not given, xmobar will try to center text vertically.
+ - =textOffset= The vertical offset, in pixels, for the text baseline. If
+ negative or not given, xmobar will try to center text vertically.
- - =textOffsets= A list of vertical offsets, in pixels, for the text
- baseline, to be used with the each of the fonts in =additionalFonts=
- (if any). If negative or not given, xmobar will try to center text
- vertically for that font.
+ - =textOffsets= A list of vertical offsets, in pixels, for the text
+ baseline, to be used with the each of the fonts in =additionalFonts=
+ (if any). If negative or not given, xmobar will try to center text
+ vertically for that font.
- - =iconOffset= The vertical offset, in pixels, for icons bottom line. If
- negative or not given, xmobar will try to center icons vertically.
+ - =iconOffset= The vertical offset, in pixels, for icons bottom line. If
+ negative or not given, xmobar will try to center icons vertically.
- - =lowerOnStart= When True the window is sent the bottom of the window
- stack initially.
+ - =lowerOnStart= When True the window is sent the bottom of the window
+ stack initially.
- - =hideOnStart= When set to True the window is initially not mapped,
- i.e. hidden. It then can be toggled manually (for example using the
- dbus interface) or automatically (by a plugin) to make it reappear.
+ - =hideOnStart= When set to True the window is initially not mapped,
+ i.e. hidden. It then can be toggled manually (for example using the
+ dbus interface) or automatically (by a plugin) to make it reappear.
- - =allDesktops= When set to True (the default), xmobar will tell the
- window manager explicitly to be shown in all desktops, by setting
- =_NET_WM_DESKTOP= to 0xffffffff.
+ - =allDesktops= When set to True (the default), xmobar will tell the
+ window manager explicitly to be shown in all desktops, by setting
+ =_NET_WM_DESKTOP= to 0xffffffff.
- - =overrideRedirect= If you're running xmobar in a tiling window
- manager, you might need to set this option to =False= so that it
- behaves as a docked application. Defaults to =True=.
+ - =overrideRedirect= If you're running xmobar in a tiling window
+ manager, you might need to set this option to =False= so that it
+ behaves as a docked application. Defaults to =True=.
- - =pickBroadest= When multiple displays are available, xmobar will
- choose by default the first one to place itself. With this flag set to
- =True= (the default is =False=) it will choose the broadest one
- instead.
+ - =pickBroadest= When multiple displays are available, xmobar will
+ choose by default the first one to place itself. With this flag set to
+ =True= (the default is =False=) it will choose the broadest one
+ instead.
- - =persistent= When True the window status is fixed i.e. hiding or
- revealing is not possible. This option can be toggled at runtime.
- Defaults to False.
+ - =persistent= When True the window status is fixed i.e. hiding or
+ revealing is not possible. This option can be toggled at runtime.
+ Defaults to False.
- - =border= TopB, TopBM, BottomB, BottomBM, FullB, FullBM or NoBorder
- (default).
+ - =border= TopB, TopBM, BottomB, BottomBM, FullB, FullBM or NoBorder
+ (default).
- TopB, BottomB, FullB take no arguments, and request drawing a border
- at the top, bottom or around xmobar's window, respectively.
+ TopB, BottomB, FullB take no arguments, and request drawing a border
+ at the top, bottom or around xmobar's window, respectively.
- TopBM, BottomBM, FullBM take an integer argument, which is the margin,
- in pixels, between the border of the window and the drawn border.
+ TopBM, BottomBM, FullBM take an integer argument, which is the margin,
+ in pixels, between the border of the window and the drawn border.
- - =borderColor= Border color.
+ - =borderColor= Border color.
- - =borderWidth= Border width in pixels.
+ - =borderWidth= Border width in pixels.
- - =iconRoot= Root folder where icons are stored. For =<icon=path/>= if
- path start with =/=, =./= or =../= it is interpreted as it is.
- Otherwise it will have
+ - =iconRoot= Root folder where icons are stored. For =<icon=path/>= if
+ path start with =/=, =./= or =../= it is interpreted as it is.
+ Otherwise it will have
- #+begin_src haskell
- iconRoot ++ "/"
- #+end_src
+ #+begin_src haskell
+ iconRoot ++ "/"
+ #+end_src
- prepended to it. Default is =.=.
+ prepended to it. Default is =.=.
- - =commands= For setting the options of the programs to run (optional).
+ - =commands= For setting the options of the programs to run (optional).
- - =sepChar= The character to be used for indicating commands in the
- output template (default '%').
+ - =sepChar= The character to be used for indicating commands in the
+ output template (default '%').
- - =alignSep= a 2 character string for aligning text in the output
- template. The text before the first character will be align to left,
- the text in between the 2 characters will be centered, and the text
- after the second character will be align to the right.
+ - =alignSep= a 2 character string for aligning text in the output
+ template. The text before the first character will be align to left,
+ the text in between the 2 characters will be centered, and the text
+ after the second character will be align to the right.
- - =template= The output template.
+ - =template= The output template.
- - =wmClass= The value for the window's X11 ~WM_CLASS~ property. Defaults
- to "xmobar".
+ - =wmClass= The value for the window's X11 ~WM_CLASS~ property. Defaults
+ to "xmobar".
- - =wmName= The value for the window's X11 ~WM_NAME~ property. Defaults to
- "xmobar".
+ - =wmName= The value for the window's X11 ~WM_NAME~ property. Defaults to
+ "xmobar".
- - =textOutput= When True, instead of running as an X11 application,
- write output to stdout, with optional color escape sequences. In
- this mode, icon and action specifications are ignored. Default is
- False.
+ - =textOutput= When True, instead of running as an X11 application,
+ write output to stdout, with optional color escape sequences. In
+ this mode, icon and action specifications are ignored. Default is
+ False.
- - =textOutputFormat= Plain, Ansi or Pango, to emit, when in text
- mode, escape color sequences using ANSI controls (for terminals) or
- pango markup. Default is Plain.
+ - =textOutputFormat= Plain, Ansi or Pango, to emit, when in text
+ mode, escape color sequences using ANSI controls (for terminals) or
+ pango markup. Default is Plain.
-*** The output =template=
+** The output =template=
- The output template is how xmobar will end up printing all of your
- configured commands. It must contain at least one command. Xmobar
- will parse the template and search for the command to be executed
- in the =commands= configuration option. First an =alias= will be
- searched (some plugins, such as =Weather= or =Network=, have default
- aliases, see the [[./plugins.org][plugin documentation]]). After that, the command
- name will be tried. If a command is found, the arguments specified
- in the =commands= list will be used.
+ The output template is how xmobar will end up printing all of your
+ configured commands. It must contain at least one command. Xmobar
+ will parse the template and search for the command to be executed
+ in the =commands= configuration option. First an =alias= will be
+ searched (some plugins, such as =Weather= or =Network=, have default
+ aliases, see the [[./plugins.org][plugin documentation]]). After that, the command
+ name will be tried. If a command is found, the arguments specified
+ in the =commands= list will be used.
- If no command is found in the =commands= list, xmobar will ask the
- operating system to execute a program with the name found in the
- template. If the execution is not successful an error will be
- reported.
+ If no command is found in the =commands= list, xmobar will ask the
+ operating system to execute a program with the name found in the
+ template. If the execution is not successful an error will be
+ reported.
-***** Template syntax
+*** Template syntax
- The syntax for the output template is as follows:
+ The syntax for the output template is as follows:
- - =%command%= will execute command and print the output. The output may
- contain markups to change the characters' color.
+ - =%command%= will execute command and print the output. The output may
+ contain markups to change the characters' color.
- - =<fc=#FF0000>string</fc>= will print =string= with =#FF0000= color
- (red). =<fc=#FF0000,#000000>string</fc>= will print =string= in red
- with a black background (=#000000=). Background absolute offsets can
- be specified for XFT fonts. =<fc=#FF0000,#000000:0>string</fc>= will
- have a background matching the bar's height.
+ - =<fc=#FF0000>string</fc>= will print =string= with =#FF0000= color
+ (red). =<fc=#FF0000,#000000>string</fc>= will print =string= in red
+ with a black background (=#000000=). Background absolute offsets can
+ be specified for XFT fonts. =<fc=#FF0000,#000000:0>string</fc>= will
+ have a background matching the bar's height.
- - =<fn=1>string</fn>= will print =string= with the first font from
- =additionalFonts=. The index =0= corresponds to the standard font.
+ - =<fn=1>string</fn>= will print =string= with the first font from
+ =additionalFonts=. The index =0= corresponds to the standard font.
- - =<hspace=X/>= will insert a blank horizontal space of =X= pixels.
- For example, to add a blank horizontal space of 123 pixels,
- =<hspace=123/>= may be used.
+ - =<hspace=X/>= will insert a blank horizontal space of =X= pixels.
+ For example, to add a blank horizontal space of 123 pixels,
+ =<hspace=123/>= may be used.
- - =<box>string</box>= will print string surrounded by a box in the
- foreground color. The =box= tag accepts several optional arguments to
- tailor its looks: see next section.
+ - =<box>string</box>= will print string surrounded by a box in the
+ foreground color. The =box= tag accepts several optional arguments to
+ tailor its looks: see next section.
- - =<icon=/path/to/icon.xbm/>= will insert the given bitmap. XPM image
- format is also supported when compiled with the =with_xpm= flag.
+ - =<icon=/path/to/icon.xbm/>= will insert the given bitmap. XPM image
+ format is also supported when compiled with the =with_xpm= flag.
- - =<action=`command` button=12345>= will execute given command when
- clicked with specified buttons. If not specified, button is equal to 1
- (left mouse button). Using old syntax (without backticks surrounding
- =command=) will result in =button= attribute being ignored.
+ - =<action=`command` button=12345>= will execute given command when
+ clicked with specified buttons. If not specified, button is equal to 1
+ (left mouse button). Using old syntax (without backticks surrounding
+ =command=) will result in =button= attribute being ignored.
- - =<raw=len:str/>= allows the encapsulation of arbitrary text =str=
- (which must be =len= =Char=s long, where =len= is encoded as a decimal
- sequence). Careful use of this and =UnsafeStdinReader=, for example,
- permits window managers to feed xmobar strings with =<action>= tags
- mixed with un-trusted content (e.g. window titles). For example, if
- xmobar is invoked as
+ - =<raw=len:str/>= allows the encapsulation of arbitrary text =str=
+ (which must be =len= =Char=s long, where =len= is encoded as a decimal
+ sequence). Careful use of this and =UnsafeStdinReader=, for example,
+ permits window managers to feed xmobar strings with =<action>= tags
+ mixed with un-trusted content (e.g. window titles). For example, if
+ xmobar is invoked as
- #+begin_src shell
- xmobar -c "[Run UnsafeStdinReader]" -t "%UnsafeStdinReader%"
- #+end_src
+ #+begin_src shell
+ xmobar -c "[Run UnsafeStdinReader]" -t "%UnsafeStdinReader%"
+ #+end_src
- and receives on standard input the line
+ and receives on standard input the line
- #+begin_src shell
- <action=`echo test` button=1><raw=41:<action=`echo mooo` button=1>foo</action>/></action>`
- #+end_src
+ #+begin_src shell
+ <action=`echo test` button=1><raw=41:<action=`echo mooo` button=1>foo</action>/></action>`
+ #+end_src
- then it will display the text
- =<action=`echo mooo` button=1>foo</action>=, which, when clicked, will
- cause =test= to be echoed.
+ then it will display the text
+ =<action=`echo mooo` button=1>foo</action>=, which, when clicked, will
+ cause =test= to be echoed.
- See the subsections below for more information on ~<box/>~,
- ~<icon/>~ and ~<action/>~.
+ See the subsections below for more information on ~<box/>~,
+ ~<icon/>~ and ~<action/>~.
-***** Boxes around text
+*** Boxes around text
- - =<box>string</box>= will print string surrounded by a box in the
- foreground color. The =box= tag accepts several optional arguments to
- tailor its looks:
+ - =<box>string</box>= will print string surrounded by a box in the
+ foreground color. The =box= tag accepts several optional arguments to
+ tailor its looks:
- - =type=: =Top=, =Bottom=, =VBoth= (a single line above or below
- string, or both), =Left=, =Right=, =HBoth= (single vertical lines),
- =Full= (a rectangle, the default).
- - =color=: the color of the box lines.
- - =width=: the width of the box lines.
- - =offset=: an alignment char (L, C or R) followed by the amount of
- pixels to offset the box lines; the alignment denotes the position
- of the resulting line, with L/R meaning top/bottom for the vertical
- lines, and left/right for horizontal ones.
- - =mt=, =mb=, =ml=, =mr= specify margins to be added at the top,
- bottom, left and right lines.
+ - =type=: =Top=, =Bottom=, =VBoth= (a single line above or below
+ string, or both), =Left=, =Right=, =HBoth= (single vertical lines),
+ =Full= (a rectangle, the default).
+ - =color=: the color of the box lines.
+ - =width=: the width of the box lines.
+ - =offset=: an alignment char (L, C or R) followed by the amount of
+ pixels to offset the box lines; the alignment denotes the position
+ of the resulting line, with L/R meaning top/bottom for the vertical
+ lines, and left/right for horizontal ones.
+ - =mt=, =mb=, =ml=, =mr= specify margins to be added at the top,
+ bottom, left and right lines.
- For example, a box underlining its text with a red line of width 2:
+ For example, a box underlining its text with a red line of width 2:
- #+begin_src shell
- <box type=Bottom width=2 color=red>string</box>
- #+end_src
+ #+begin_src shell
+ <box type=Bottom width=2 color=red>string</box>
+ #+end_src
- and if you wanted an underline and an overline with a margin of 2
- pixels either side:
+ and if you wanted an underline and an overline with a margin of 2
+ pixels either side:
- #+begin_src shell
- <box type=VBoth mt=2 mb=2>string</box>
- #+end_src
+ #+begin_src shell
+ <box type=VBoth mt=2 mb=2>string</box>
+ #+end_src
- When xmobar is run in text mode with output format swaybar, box
- types, colors and widths are valid too, but margins and offsets
- are ignored.
+ When xmobar is run in text mode with output format swaybar, box
+ types, colors and widths are valid too, but margins and offsets
+ are ignored.
-***** Bitmap Icons
+*** Bitmap Icons
- It's possible to insert in the global templates icon directives of the
- form:
+ It's possible to insert in the global templates icon directives of the
+ form:
- prepended to it. Default is =.=.
+ prepended to it. Default is =.=.
- #+begin_src shell
- <icon=/path/to/bitmap.xbm/>
- #+end_src
+ #+begin_src shell
+ <icon=/path/to/bitmap.xbm/>
+ #+end_src
- which will produce the expected result. Accepted image formats are XBM
- and XPM (when =with_xpm= flag is enabled). If path does not start with
- =/=, =./=, =../= it will have
+ which will produce the expected result. Accepted image formats are XBM
+ and XPM (when =with_xpm= flag is enabled). If path does not start with
+ =/=, =./=, =../= it will have
- #+begin_src haskell
- iconRoot ++ "/"
- #+end_src
+ #+begin_src haskell
+ iconRoot ++ "/"
+ #+end_src
- prepended to it.
+ prepended to it.
- Icons are ignored when xmobar is run in text output mode.
+ Icons are ignored when xmobar is run in text output mode.
-***** Action Directives
+*** Action Directives
- It's also possible to use action directives of the form:
+ It's also possible to use action directives of the form:
- #+begin_src shell
- <action=`command` button=12345>
- #+end_src
+ #+begin_src shell
+ <action=`command` button=12345>
+ #+end_src
- which will be executed when clicked on with specified mouse
- buttons. This tag can be nested, allowing different commands to
- be run depending on button clicked.
+ which will be executed when clicked on with specified mouse
+ buttons. This tag can be nested, allowing different commands to
+ be run depending on button clicked.
- Actions work also when xmobar is run in text mode and used as
- the status command of swaybar.
+ Actions work also when xmobar is run in text mode and used as
+ the status command of swaybar.
-*** The =commands= configuration option
+** The =commands= configuration option
- The =commands= configuration option is a list of commands information
- and arguments to be used by xmobar when parsing the output template.
- Each member of the list consists in a command prefixed by the =Run=
- keyword. Each command has arguments to control the way xmobar is going
- to execute it.
+ The =commands= configuration option is a list of commands information
+ and arguments to be used by xmobar when parsing the output template.
+ Each member of the list consists in a command prefixed by the =Run=
+ keyword. Each command has arguments to control the way xmobar is going
+ to execute it.
- The option consists in a list of commands separated by a comma and
- enclosed by square parenthesis.
+ The option consists in a list of commands separated by a comma and
+ enclosed by square parenthesis.
- Example:
+ Example:
- #+begin_src haskell
- [Run Memory ["-t","Mem: <usedratio>%"] 10, Run Swap [] 10]
- #+end_src
+ #+begin_src haskell
+ [Run Memory ["-t","Mem: <usedratio>%"] 10, Run Swap [] 10]
+ #+end_src
- to run the Memory monitor plugin with the specified template, and the
- swap monitor plugin, with default options, every second. And here's an
- example of a template for the commands above using an icon:
+ to run the Memory monitor plugin with the specified template, and the
+ swap monitor plugin, with default options, every second. And here's an
+ example of a template for the commands above using an icon:
- #+begin_src haskell
- template = "<icon=/home/jao/.xmobar/mem.xbm/><memory> <swap>"
- #+end_src
+ #+begin_src haskell
+ template = "<icon=/home/jao/.xmobar/mem.xbm/><memory> <swap>"
+ #+end_src
- This example will run "xclock" command when date is clicked:
+ This example will run "xclock" command when date is clicked:
- #+begin_src haskell
- template = "<action=`xclock`>%date%</action>"
- #+end_src
+ #+begin_src haskell
+ template = "<action=`xclock`>%date%</action>"
+ #+end_src
- The only internal available command is =Com= (see below Executing
- External Commands). All other commands are provided by plugins. xmobar
- comes with some plugins, providing a set of system monitors, a standard
- input reader, an Unix named pipe reader, a configurable date plugin, and
- much more: we list all available plugins below.
+ The only internal available command is =Com= (see below Executing
+ External Commands). All other commands are provided by plugins. xmobar
+ comes with some plugins, providing a set of system monitors, a standard
+ input reader, an Unix named pipe reader, a configurable date plugin, and
+ much more: we list all available plugins below.
- Other commands can be created as plugins with the Plugin infrastructure.
- See below.
+ Other commands can be created as plugins with the Plugin infrastructure.
+ See below.
* Runtime behaviour
-*** Running xmobar with =i3status=
+** Running xmobar with =i3status=
- xmobar can be used to display information generated by [[http://i3wm.org/i3status/][i3status]], a small
- program that gathers system information and outputs it in formats
- suitable for being displayed by the dzen2 status bar, wmii's status bar
- or xmobar's =StdinReader=. See [[http://i3wm.org/i3status/manpage.html#_using_i3status_with_xmobar][i3status manual]] for further details.
+ xmobar can be used to display information generated by [[http://i3wm.org/i3status/][i3status]], a small
+ program that gathers system information and outputs it in formats
+ suitable for being displayed by the dzen2 status bar, wmii's status bar
+ or xmobar's =StdinReader=. See [[http://i3wm.org/i3status/manpage.html#_using_i3status_with_xmobar][i3status manual]] for further details.
-*** Dynamically sizing xmobar
+** Dynamically sizing xmobar
- See [[https://codeberg.org/xmobar/xmobar/issues/239#issuecomment-233206552][this idea]] by Jonas Camillus Jeppensen for a way of adapting
- dynamically xmobar's size and run it alongside a system tray widget such
- as trayer or stalonetray (although the idea is not limited to trays,
- really). For your convenience, there is a version of Jonas' script in
- [[../examples/padding-icon.sh][examples/padding-icon.sh]].
+ See [[https://codeberg.org/xmobar/xmobar/issues/239#issuecomment-233206552][this idea]] by Jonas Camillus Jeppensen for a way of adapting
+ dynamically xmobar's size and run it alongside a system tray widget such
+ as trayer or stalonetray (although the idea is not limited to trays,
+ really). For your convenience, there is a version of Jonas' script in
+ [[../examples/padding-icon.sh][examples/padding-icon.sh]].
-*** Signal Handling
+** Signal Handling
- xmobar reacts to ~SIGUSR1~ and ~SIGUSR2~:
+ xmobar reacts to ~SIGUSR1~ and ~SIGUSR2~:
- - After receiving ~SIGUSR1~ xmobar moves its position to the next screen.
+ - After receiving ~SIGUSR1~ xmobar moves its position to the next screen.
- - After receiving ~SIGUSR2~ xmobar repositions itself on the current
- screen.
+ - After receiving ~SIGUSR2~ xmobar repositions itself on the current
+ screen.
* The DBus Interface
When compiled with the optional =with_dbus= flag, xmobar can be controlled
@@ -446,7 +446,7 @@ available [[https://codeberg.org/xmobar/xmobar/src/branch/master/examples/xmobar
An example using the =dbus-send= command line utility:
#+begin_src shell
- dbus-send \
+ dbus-send \
--session \
--dest=org.Xmobar.Control \
--type=method_call \
@@ -461,7 +461,7 @@ available [[https://codeberg.org/xmobar/xmobar/src/branch/master/examples/xmobar
#+begin_src shell
# send to another screen, reveal and toggle the persistent flag
dbus-send [..] \
- "string:ChangeScreen 0" "string:Reveal 0" "string:TogglePersistent"
+ "string:ChangeScreen 0" "string:Reveal 0" "string:TogglePersistent"
#+end_src
The =Toggle=, =Reveal=, and =Hide= signals take an additional integer