diff --git a/doc/spacebar.1 b/doc/spacebar.1 deleted file mode 100644 index 0ce29c6..0000000 --- a/doc/spacebar.1 +++ /dev/null @@ -1,313 +0,0 @@ -'\" t -.\" Title: spacebar -.\" Author: [see the "AUTHOR(S)" section] -.\" Generator: Asciidoctor 2.0.10 -.\" Date: 2021-04-08 -.\" Manual: spacebar manual -.\" Source: spacebar -.\" Language: English -.\" -.TH "SPACEBAR" "1" "2021-04-08" "spacebar" "spacebar manual" -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.ss \n[.ss] 0 -.nh -.ad l -.de URL -\fI\\$2\fP <\\$1>\\$3 -.. -.als MTO URL -.if \n[.g] \{\ -. mso www.tmac -. am URL -. ad l -. . -. am MTO -. ad l -. . -. LINKSTYLE blue R < > -.\} -.SH "NAME" -spacebar \- a simple status bar for macOS -.SH "SYNOPSIS" -.sp -\fBspacebar\fP [\fB\-v\fP,\fB\-\-version\fP|\fB\-V\fP,\fB\-\-verbose\fP|\fB\-m\fP,\fB\-\-message\fP \fImsg\fP|\fB\-c\fP,\fB\-\-config\fP \fIconfig_file\fP] -.SH "DESCRIPTION" -.sp -\fBspacebar\fP is a simple status bar for macOS. -.SH "OPTIONS" -.sp -\fB\-v\fP, \fB\-\-version\fP -.RS 4 -Print the version and exit. -.RE -.sp -\fB\-V\fP, \fB\-\-verbose\fP -.RS 4 -Output debug information to stdout. -.RE -.sp -\fB\-m\fP, \fB\-\-message\fP \fI\fP -.RS 4 -Send message to a running instance of spacebar. -.RE -.sp -\fB\-c\fP, \fB\-\-config\fP \fI\fP -.RS 4 -Use the specified configuration file. -.RE -.SH "CONFIG" -.SS "General Syntax" -.sp -spacebar \-m config -.RS 4 -Get or set the value of . -.RE -.SS "Settings" -.sp -\fBdebug_output\fP [\fI\fP] -.RS 4 -Enable output of debug information to stdout. -.RE -.sp -\fBdisplay\fP [\fI\fP] -.RS 4 -Display to draw the bar on. -.br -Must be one of \fImain\fP or \fIall\fP. -.RE -.sp -\fBposition\fP [\fI\fP] -.RS 4 -Position on the screen to draw the bar. -.br -Must be one of \fItop\fP or \fIbottom\fP. -.RE -.sp -\fBheight\fP [\fI\fP] -.RS 4 -Height in pixels to draw the bar. -.RE -.sp -\fBtitle\fP [\fI\fP] -.RS 4 -Enable focused window title display at the centre of the bar. -.br -This cannot be enabled when \fIcenter_shell\(cqis set to \(aqon\fP. -.RE -.sp -\fBspaces\fP [\fI\fP] -.RS 4 -Enable space indicator on the left of the bar. -.RE -.sp -\fBspace_icon_strip\fP [\fI \fP] -.RS 4 -Specify symbols separated by whitespace to be used for visualizing spaces. -.RE -.sp -\fBspaces_for_all_displays\fP [\fI\fP] -.RS 4 -Enable space indicators for spaces on each display. -.RE -.sp -\fBspace_icon\fP [\fI\fP] -.RS 4 -Specify a general symbol to use for any given space that does not have a match in \fIspace_icon_strip\fP. -.RE -.sp -\fBspace_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the current space icon. -.RE -.sp -\fBspace_icon_color_secondary\fP [\fI\fP] -.RS 4 -Color to use for drawing the current space icon of the second display. -.RE -.sp -\fBspace_icon_color_tertiary\fP [\fI\fP] -.RS 4 -Color to use for drawing the current space icon of the third display. -.RE -.sp -\fBdisplay_separator\fP [\fI\fP] -.RS 4 -Enable separator between the spaces for each display. -.RE -.sp -\fBdisplay_separator_icon\fP [\fI\fP] -.RS 4 -Specify a symbol to use for the display separator. -.RE -.sp -\fBdisplay_separator_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the display separator icon. -.RE -.sp -\fBclock\fP [\fI\fP] -.RS 4 -Enable clock on the right of the bar. -.RE -.sp -\fBpower\fP [\fI\fP] -.RS 4 -Enable power indicator on the right of the bar. -.RE -.sp -\fBpadding_left\fP [\fI\fP] -.RS 4 -Padding in pixels between the left edge of the display and the first item. -.RE -.sp -\fBpadding_right\fP [\fI\fP] -.RS 4 -Padding in pixels between the right edge of the display and the last item. -.RE -.sp -\fBspacing_left\fP [\fI\fP] -.RS 4 -Spacing in pixels between the left space indicators. -.RE -.sp -\fBspacing_right\fP [\fI\fP] -.RS 4 -Spacing in pixels between the right status segments. -.RE -.sp -\fBtext_font\fP [\fI::\fP] -.RS 4 -Specify name, style and size of font to use for drawing text. -.br -Use \fIFont Book.app\fP to identify the correct name. -.RE -.sp -\fBicon_font\fP [\fI::\fP] -.RS 4 -Specify name, style and size of font to use for drawing icon symbols. -.br -Use \fIFont Book.app\fP to identify the correct name. -.RE -.sp -\fBbackground_color\fP [\fI\fP] -.RS 4 -Color to use for drawing status bar background. -.RE -.sp -\fBforeground_color\fP [\fI\fP] -.RS 4 -Color to use for drawing status bar elements. -.RE -.sp -\fBpower_icon_strip\fP [\fI \fP] -.RS 4 -Specify two symbols separated by whitespace. -.br -The first symbol represents battery power and the second symbol indicates AC. -.RE -.sp -\fBpower_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the power (charging) icon. -.RE -.sp -\fBbattery_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the battery icon. -.RE -.sp -\fBclock_icon\fP [\fI\fP] -.RS 4 -Specify a symbol to represent the current time. -.RE -.sp -\fBclock_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the clock icon. -.RE -.sp -\fBclock_format\fP [\fI\fP] -.RS 4 -Specify a format for the current time, according to the strftime function. -.RE -.sp -\fBdnd\fP [\fI\fP] -.RS 4 -Enable a DoNotDisturb indicator on the right of the bar. -.RE -.sp -\fBdnd_icon\fP [\fI\fP] -.RS 4 -Specify a symbol to represent the current DoNotDisturb status. -.RE -.sp -\fBdnd_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the DoNotDisturb icon. -.RE -.sp -\fBleft_shell\fP [\fI\fP] -.RS 4 -Enable shell output on the left of the bar. -.RE -.sp -\fBright_shell\fP [\fI\fP] -.RS 4 -Enable shell output on the right of the bar. -.RE -.sp -\fBcenter_shell\fP [\fI\fP] -.RS 4 -Enable shell output at the center of the bar. -.br -This cannot be enabled when \fItitle\fP is set to \fIon\fP. -.RE -.sp -\fBleft_shell_icon\fP [\fI\fP] -.RS 4 -Specify a symbol to prefix the left shell output. -.RE -.sp -\fBleft_shell_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the left shell icon. -.RE -.sp -\fBleft_shell_command\fP [\fI\fP] -.RS 4 -Command pipeline to retrieve the output for displaying in the left shell section. -.br -There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. -.RE -.sp -\fBright_shell_icon\fP [\fI\fP] -.RS 4 -Specify a symbol to prefix the right shell output. -.RE -.sp -\fBright_shell_icon_color\fP [\fI\fP] -.RS 4 -Color to use for drawing the right shell icon. -.RE -.sp -\fBright_shell_command\fP [\fI\fP] -.RS 4 -Command pipeline to retrieve the output for displaying in the right shell section. -.br -There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. -.RE -.sp -\fBcenter_shell_command\fP [\fI\fP] -.RS 4 -Command pipeline to retrieve the output for displaying in the center shell section. -.br -There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. -.br -.RE -.SH "EXIT CODES" -.sp -If \fBspacebar\fP can\(cqt handle a message, it will return a non\-zero exit code. -.SH "AUTHOR" -.sp -Calum MacRae \ No newline at end of file diff --git a/doc/spacebar.asciidoc b/doc/spacebar.asciidoc deleted file mode 100644 index ec11e59..0000000 --- a/doc/spacebar.asciidoc +++ /dev/null @@ -1,211 +0,0 @@ -: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 - a simple status bar for macOS - -Synopsis --------- - -*spacebar* [*-v*,*--version*|*-V*,*--verbose*|*-m*,*--message* 'msg'|*-c*,*--config* 'config_file'] - -Description ------------ - -*spacebar* is a simple status bar for macOS. - -Options -------- -*-v*, *--version*:: - Print the version and exit. - -*-V*, *--verbose*:: - Output debug information to stdout. - -*-m*, *--message* '':: - Send message to a running instance of spacebar. - -*-c*, *--config* '':: - Use the specified configuration file. - -Config ------- - -General Syntax -~~~~~~~~~~~~~~ - -spacebar -m config :: - Get or set the value of . - -Settings -~~~~~~~~ - -*debug_output* ['']:: - Enable output of debug information to stdout. - -*display* ['']:: - Display to draw the bar on. + - Must be one of 'main' or 'all'. - -*position* ['']:: - Position on the screen to draw the bar. + - Must be one of 'top' or 'bottom'. - -*height* ['']:: - Height in pixels to draw the bar. - -*title* ['']:: - Enable focused window title display at the centre of the bar. + - This cannot be enabled when 'center_shell'is set to 'on'. - -*spaces* ['']:: - Enable space indicator on the left of the bar. - -*space_icon_strip* [' ']:: - Specify symbols separated by whitespace to be used for visualizing spaces. - -*spaces_for_all_displays* ['']:: - Enable space indicators for spaces on each display. - -*space_icon* ['']:: - Specify a general symbol to use for any given space that does not have a match in 'space_icon_strip'. - -*space_icon_color* ['']:: - Color to use for drawing the current space icon. - -*space_icon_color_secondary* ['']:: - Color to use for drawing the current space icon of the second display. - -*space_icon_color_tertiary* ['']:: - Color to use for drawing the current space icon of the third display. - -*display_separator* ['']:: - Enable separator between the spaces for each display. - -*display_separator_icon* ['']:: - Specify a symbol to use for the display separator. - -*display_separator_icon_color* ['']:: - Color to use for drawing the display separator icon. - -*clock* ['']:: - Enable clock on the right of the bar. - -*power* ['']:: - Enable power indicator on the right of the bar. - -*padding_left* ['']:: - Padding in pixels between the left edge of the display and the first item. - -*padding_right* ['']:: - Padding in pixels between the right edge of the display and the last item. - -*spacing_left* ['']:: - Spacing in pixels between the left space indicators. - -*spacing_right* ['']:: - Spacing in pixels between the right status segments. - -*text_font* ['::']:: - Specify name, style and size of font to use for drawing text. + - Use 'Font Book.app' to identify the correct name. - -*icon_font* ['::']:: - 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 to use for drawing status bar background. - -*foreground_color* ['']:: - Color to use for drawing status bar elements. - -*power_icon_strip* [' ']:: - Specify two symbols separated by whitespace. + - The first symbol represents battery power and the second symbol indicates AC. - -*power_icon_color* ['']:: - Color to use for drawing the power (charging) icon. - -*battery_icon_color* ['']:: - Color to use for drawing the battery icon. - -*clock_icon* ['']:: - Specify a symbol to represent the current time. - -*clock_icon_color* ['']:: - Color to use for drawing the clock icon. - -*clock_format* ['']:: - Specify a format for the current time, according to the strftime function. - -*dnd* ['']:: - Enable a DoNotDisturb indicator on the right of the bar. - -*dnd_icon* ['']:: - Specify a symbol to represent the current DoNotDisturb status. - -*dnd_icon_color* ['']:: - Color to use for drawing the DoNotDisturb icon. - -*left_shell* ['']:: - Enable shell output on the left of the bar. - -*right_shell* ['']:: - Enable shell output on the right of the bar. - -*center_shell* ['']:: - Enable shell output at the center of the bar. + - This cannot be enabled when 'title' is set to 'on'. - -*left_shell_icon* ['']:: - Specify a symbol to prefix the left shell output. - -*left_shell_icon_color* ['']:: - Color to use for drawing the left shell icon. - -*left_shell_command* ['']:: - Command pipeline to retrieve the output for displaying in the left shell section. + - There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. - -*right_shell_icon* ['']:: - Specify a symbol to prefix the right shell output. - -*right_shell_icon_color* ['']:: - Color to use for drawing the right shell icon. - -*right_shell_command* ['']:: - Command pipeline to retrieve the output for displaying in the right shell section. + - There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. - -*center_shell_command* ['']:: - Command pipeline to retrieve the output for displaying in the center shell section. + - There is NO timeout protection for the command pipeline, so be sure to set it to something that returns output quickly. + - - -Exit Codes ----------- - -If *spacebar* can't handle a message, it will return a non-zero exit code. - -Author ------- - -Calum MacRae diff --git a/examples/spacebarrc b/examples/spacebarrc deleted file mode 100755 index ab6d6a9..0000000 --- a/examples/spacebarrc +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/env sh - -spacebar -m config position top -spacebar -m config display main -spacebar -m config height 26 -spacebar -m config title on -spacebar -m config spaces on -spacebar -m config clock on -spacebar -m config power on -spacebar -m config padding_left 20 -spacebar -m config padding_right 20 -spacebar -m config spacing_left 25 -spacebar -m config spacing_right 15 -spacebar -m config text_font "Menlo:Regular:12.0" -spacebar -m config icon_font "Font Awesome 5 Free:Solid:12.0" -spacebar -m config background_color 0xff202020 -spacebar -m config foreground_color 0xffa8a8a8 -spacebar -m config power_icon_color 0xffcd950c -spacebar -m config battery_icon_color 0xffd75f5f -spacebar -m config dnd_icon_color 0xffa8a8a8 -spacebar -m config clock_icon_color 0xffa8a8a8 -spacebar -m config power_icon_strip   -spacebar -m config space_icon • -spacebar -m config space_icon_color 0xffffab91 -spacebar -m config space_icon_color_secondary 0xff78c4d4 -spacebar -m config space_icon_color_tertiary 0xfffff9b0 -spacebar -m config space_icon_strip 1 2 3 4 5 6 7 8 9 10 -spacebar -m config spaces_for_all_displays on -spacebar -m config clock_icon  -spacebar -m config dnd_icon  -spacebar -m config clock_format "%d/%m/%y %R" -spacebar -m config right_shell on -spacebar -m config right_shell_icon  -spacebar -m config right_shell_command "whoami" - -echo "spacebar configuration loaded.."