monospace for defaults

This commit is contained in:
enkore 2014-01-16 23:05:47 +01:00
parent 0a897e64ab
commit 4301ddd2d7

View File

@ -274,15 +274,15 @@ Available formatters:
Settings: Settings:
:format: (default: '♪: {volume}') :format: (default: ``♪: {volume}``)
:mixer: ALSA mixer (default: 'Master') :mixer: ALSA mixer (default: ``Master``)
:mixer_id: ALSA mixer id (default: '0') :mixer_id: ALSA mixer id (default: ``0``)
:card: ALSA sound card (default: '0') :card: ALSA sound card (default: ``0``)
:muted: (default: 'M') :muted: (default: ``M``)
:unmuted: (default: '') :unmuted: (default: ````)
:color_muted: (default: '#AAAAAA') :color_muted: (default: ``#AAAAAA``)
:color: (default: '#FFFFFF') :color: (default: ``#FFFFFF``)
:channel: (default: '0') :channel: (default: ``0``)
@ -300,9 +300,9 @@ Available formatters:
Settings: Settings:
:format: format string, formatters: brightness, max_brightness, percentage (default: '{brightness}/{max_brightness}') :format: format string, formatters: brightness, max_brightness, percentage (default: ``{brightness}/{max_brightness}``)
:backlight: backlight, see `/sys/class/backlight/` (default: 'acpi_video0') :backlight: backlight, see `/sys/class/backlight/` (default: ``acpi_video0``)
:color: (default: '#FFFFFF') :color: (default: ``#FFFFFF``)
@ -325,14 +325,14 @@ Available formatters:
Settings: Settings:
:battery_ident: The name of your battery, usually BAT0 or BAT1 (default: 'BAT0') :battery_ident: The name of your battery, usually BAT0 or BAT1 (default: ``BAT0``)
:format: (default: '{status} {remaining}') :format: (default: ``{status} {remaining}``)
:alert: Display a libnotify-notification on low battery (default: 'False') :alert: Display a libnotify-notification on low battery (default: ``False``)
:alert_percentage: (default: '10') :alert_percentage: (default: ``10``)
:alert_format_title: The title of the notification, all formatters can be used (default: 'Low battery') :alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``)
:alert_format_body: The body text of the notification, all formatters can be used (default: 'Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!') :alert_format_body: The body text of the notification, all formatters can be used (default: ``Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!``)
:path: Override the default-generated path (default: 'None') :path: Override the default-generated path (default: ``None``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: '{'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL'}') :status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL'}``)
@ -345,7 +345,7 @@ This class shows a clock
Settings: Settings:
:format: stftime format string, `None` means to use the default, locale-dependent format (default: 'None') :format: stftime format string, `None` means to use the default, locale-dependent format (default: ``None``)
@ -361,9 +361,9 @@ and `{percentage_avail}` formats.
Settings: Settings:
:format: (default: '{free}/{avail}') :format: (default: ``{free}/{avail}``)
:path: (required) :path: (required)
:divisor: divide all byte values by this value, commonly 1024**3 (gigabyte) (default: '1073741824') :divisor: divide all byte values by this value, commonly 1024**3 (gigabyte) (default: ``1073741824``)
@ -393,10 +393,10 @@ Settings:
:format: (required) :format: (required)
:components: (required) :components: (required)
:transforms: (default: '{}') :transforms: (default: ``{}``)
:base_path: (default: '/') :base_path: (default: ``/``)
:color: (default: '#FFFFFF') :color: (default: ``#FFFFFF``)
:interval: (default: '5') :interval: (default: ``5``)
@ -409,7 +409,7 @@ Shows system load
Settings: Settings:
:format: format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable). (default: '{avg1} {avg5}') :format: format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable). (default: ``{avg1} {avg5}``)
@ -425,11 +425,11 @@ The `backends` setting determines the backends to use. Currently available are:
Settings: Settings:
:backends: List of backends (instances of `i3pystatus.mail.xxx.zzz`) :backends: List of backends (instances of `i3pystatus.mail.xxx.zzz`)
:color: (default: '#ffffff') :color: (default: ``#ffffff``)
:color_unread: (default: '#ff0000') :color_unread: (default: ``#ff0000``)
:format: (default: '{unread} new email') :format: (default: ``{unread} new email``)
:format_plural: (default: '{unread} new emails') :format_plural: (default: ``{unread} new emails``)
:hide_if_null: Don't output anything if there are no new mails (default: 'True') :hide_if_null: Don't output anything if there are no new mails (default: ``True``)
Currently available backends are: Currently available backends are:
@ -445,11 +445,11 @@ Checks for mail on a IMAP server
Settings: Settings:
:host: (required) :host: (required)
:port: (default: '993') :port: (default: ``993``)
:username: (required) :username: (required)
:password: (required) :password: (required)
:ssl: (default: 'True') :ssl: (default: ``True``)
:mailbox: (default: 'INBOX') :mailbox: (default: ``INBOX``)
@ -516,7 +516,7 @@ Requires psutil (from PyPI)
Settings: Settings:
:format: format string used for output. (default: '{avail_mem} MB') :format: format string used for output. (default: ``{avail_mem} MB``)
@ -530,9 +530,9 @@ unread posts in any bookmark in the mods.de forums.
Settings: Settings:
:format: Use {unread} as the formatter for number of unread posts (default: '{unread} new posts in bookmarks') :format: Use {unread} as the formatter for number of unread posts (default: ``{unread} new posts in bookmarks``)
:offset: subtract number of posts before output (default: '0') :offset: subtract number of posts before output (default: ``0``)
:color: (default: '#7181fe') :color: (default: ``#7181fe``)
:username: (required) :username: (required)
:password: (required) :password: (required)
@ -562,10 +562,10 @@ Left click on the module play/pauses, right click (un)mutes.
Settings: Settings:
:host: (default: 'localhost') :host: (default: ``localhost``)
:port: MPD port (default: '6600') :port: MPD port (default: ``6600``)
:format: formatp string (default: '{title} {status}') :format: formatp string (default: ``{title} {status}``)
:status: Dictionary mapping pause, play and stop to output (default: '{'stop': '◾', 'play': '▶', 'pause': '▷'}') :status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'play': '▶', 'pause': '▷'}``)
@ -594,13 +594,13 @@ Not available addresses (i.e. no IPv6 connectivity) are replaced with empty stri
Settings: Settings:
:interface: Interface to obtain information for (default: 'eth0') :interface: Interface to obtain information for (default: ``eth0``)
:format_up: (default: '{interface}: {v4}') :format_up: (default: ``{interface}: {v4}``)
:color_up: (default: '#00FF00') :color_up: (default: ``#00FF00``)
:format_down: (default: '{interface}') :format_down: (default: ``{interface}``)
:color_down: (default: '#FF0000') :color_down: (default: ``#FF0000``)
:detached_down: If the interface doesn't exist, display it as if it were down (default: 'False') :detached_down: If the interface doesn't exist, display it as if it were down (default: ``False``)
:name: (default: 'eth0') :name: (default: ``eth0``)
@ -612,7 +612,7 @@ parcel
Settings: Settings:
:instance: Tracker instance :instance: Tracker instance
:format: (default: '{name}:{progress}') :format: (default: ``{name}:{progress}``)
:name: :name:
@ -633,9 +633,9 @@ Available formatters:
Settings: Settings:
:format: (default: '♪: {volume}') :format: (default: ``♪: {volume}``)
:muted: (default: 'M') :muted: (default: ``M``)
:unmuted: (default: '') :unmuted: (default: ````)
@ -658,12 +658,12 @@ Available formatters:
Settings: Settings:
:address: Address of pyLoad webinterface (default: 'http://127.0.0.1:8000') :address: Address of pyLoad webinterface (default: ``http://127.0.0.1:8000``)
:format: (default: '{captcha} {progress_all:.1f}% {speed:.1f} kb/s') :format: (default: ``{captcha} {progress_all:.1f}% {speed:.1f} kb/s``)
:captcha_true: (default: 'Captcha waiting') :captcha_true: (default: ``Captcha waiting``)
:captcha_false: (default: '') :captcha_false: (default: ````)
:download_true: (default: 'Downloads enabled') :download_true: (default: ``Downloads enabled``)
:download_false: (default: 'Downloads disabled') :download_false: (default: ``Downloads disabled``)
:username: (required) :username: (required)
:password: (required) :password: (required)
@ -680,10 +680,10 @@ The groups of the regex are passed to the format string as positional arguments.
Settings: Settings:
:format: format string used for output (default: '{0}') :format: format string used for output (default: ``{0}``)
:regex: (required) :regex: (required)
:file: file to search for regex matches :file: file to search for regex matches
:flags: Python.re flags (default: '0') :flags: Python.re flags (default: ``0``)
@ -702,10 +702,10 @@ Available formatters are {pid} and {name}.
Settings: Settings:
:format_up: (default: '{name}') :format_up: (default: ``{name}``)
:format_down: (default: '{name}') :format_down: (default: ``{name}``)
:color_up: (default: '#00FF00') :color_up: (default: ``#00FF00``)
:color_down: (default: '#FF0000') :color_down: (default: ``#FF0000``)
:path: (required) :path: (required)
:name: (required) :name: (required)
@ -722,10 +722,10 @@ AMD is currently not supported as they can only report a relative temperature, w
Settings: Settings:
:format: format string used for output. {temp} is the temperature in degrees celsius, {critical} and {high} are the trip point temps. (default: '{temp} °C') :format: format string used for output. {temp} is the temperature in degrees celsius, {critical} and {high} are the trip point temps. (default: ``{temp} °C``)
:color: (default: '#FFFFFF') :color: (default: ``#FFFFFF``)
:color_critical: (default: '#FF0000') :color_critical: (default: ``#FF0000``)
:high_factor: (default: '0.7') :high_factor: (default: ``0.7``)
@ -739,7 +739,7 @@ Display static, colored text.
Settings: Settings:
:text: (required) :text: (required)
:color: HTML color code #RRGGBB (default: 'None') :color: HTML color code #RRGGBB (default: ``None``)
@ -760,8 +760,8 @@ Requires pywapi from PyPI.
Settings: Settings:
:location_code: (required) :location_code: (required)
:units: Celsius (C) or Fahrenheit (F) (default: 'C') :units: Celsius (C) or Fahrenheit (F) (default: ``C``)
:format: (default: '{current_temp}') :format: (default: ``{current_temp}``)
@ -783,13 +783,13 @@ the same, except for these additional formatters and that detached_down doesn't
Settings: Settings:
:interface: Interface to obtain information for (default: 'wlan0') :interface: Interface to obtain information for (default: ``wlan0``)
:format_up: (default: '{interface}: {v4}') :format_up: (default: ``{interface}: {v4}``)
:color_up: (default: '#00FF00') :color_up: (default: ``#00FF00``)
:format_down: (default: '{interface}') :format_down: (default: ``{interface}``)
:color_down: (default: '#FF0000') :color_down: (default: ``#FF0000``)
:detached_down: If the interface doesn't exist, display it as if it were down (default: 'False') :detached_down: If the interface doesn't exist, display it as if it were down (default: ``False``)
:name: (default: 'eth0') :name: (default: ``eth0``)