SketchyBar/doc/spacebar.asciidoc

:man source:   Spacebar
:man version:  {revnumber}
:man manual:   Spacebar Manual

ifdef::env-github[]
:toc:
:toc-title:
:toc-placement!:
:numbered:
endif::[]

spacebar(1)
===========

ifdef::env-github[]
toc::[]
endif::[]

Name
----

spacebar - Status bar for mac

Synopsis
--------

*spacebar* [*-v*,*--version*|*-V*,*--verbose*|*-m*,*--message* 'msg'|*-c*,*--config* 'config_file']

Description
-----------

*spacebar* is a tiling window manager for macOS based on binary space partitioning.

Options
-------
*-v*, *--version*::
    Print the version and exit.

*-V*, *--verbose*::
    Output debug information to stdout.

*-m*, *--message* '<msg>'::
    Send message to a running instance of spacebar.

*-c*, *--config* '<config_file>'::
    Use the specified configuration file.

Config
------

General Syntax
~~~~~~~~~~~~~~

spacebar -m config <setting>::
    Get or set the value of <setting>.

Settings
~~~~~~~~

*debug_output* ['<BOOL_SEL>']::
    Enable output of debug information to stdout.

*position* ['<position>']::
    Position on the screen to draw the bar. +
    Must be one of 'top' or 'bottom'.

*height* ['<NUM>']::
    Height in pixels to draw the bar.

*spacing_left* ['<NUM>']::
    Spacing in pixels between the left space indicators.

*spacing_right* ['<NUM>']::
    Spacing in pixels between the right status segments.

*text_font* ['<font_family>:<font_style>:<font_size>']::
    Specify name, style and size of font to use for drawing text. +
    Use 'Font Book.app' to identify the correct name.

*icon_font* ['<font_family>:<font_style>:<font_size>']::
    Specify name, style and size of font to use for drawing icon symbols. +
    Use 'Font Book.app' to identify the correct name.

*background_color* ['<COLOR>']::
    Color to use for drawing status bar background.

*foreground_color* ['<COLOR>']::
    Color to use for drawing status bar elements.

*space_icon_strip* ['<sym_1> <sym_2> <sym_n>']::
    Specify symbols separated by whitespace to be used for visualizing spaces.

*power_icon_strip* ['<sym_battery> <sym_ac>']::
    Specify two symbols separated by whitespace. +
    The first symbol represents battery power and the second symbol indicates AC.

*power_icon_color* ['<COLOR>']::
    Color to use for drawing the power (charing) icon.

*battery_icon_color* ['<COLOR>']::
    Color to use for drawing the battery icon.

*space_icon* ['<sym>']::
    Specify a general symbol to use for any given space that does not have a match in 'space_icon_strip'.

*space_icon_color* ['<COLOR>']::
    Color to use for drawing the current space icon.

*clock_icon* ['<sym>']::
    Specify a symbol to represent the current time.

*clock_icon_color* ['<COLOR>']::
    Color to use for drawing the clock icon.

*clock_format* ['<sym>']::
    Specify a format for the current time, according to the strftime function.

*dnd_icon* ['<sym>']::
    Specify a symbol to represent the current DoNotDisturb status.

*dnd_icon_color* ['<COLOR>']::
    Color to use for drawing the DoNotDisturb icon.

Exit Codes
----------

If *spacebar* can't handle a message, it will return a non-zero exit code.

Author
------

Calum MacRae <hi at cmacr.ae>