]> git.sur5r.net Git - i3/i3status/commitdiff
Merge pull request #251 from tomaskrizek/man-eth-wireless-format
authorIngo Bürk <admin@airblader.de>
Tue, 27 Mar 2018 07:10:51 +0000 (09:10 +0200)
committerGitHub <noreply@github.com>
Tue, 27 Mar 2018 07:10:51 +0000 (09:10 +0200)
man: explicitly use format_up/format_down in ethernet, wireless conf

1  2 
man/i3status.man

diff --combined man/i3status.man
index 7d81203874d4f70f1a3e7fd9ab633b2c228e7974,943653e981b6b7760c106f9f39b41ac3b14b7b50..01fa9ce5cd2d8b5030dfdf98e20a44587e556e69
@@@ -24,12 -24,13 +24,12 @@@ configuration files in the following or
  
  == DESCRIPTION
  
 -i3status is a small program (about 1500 SLOC) for generating a status bar for
 -i3bar, dzen2, xmobar, lemonbar or similar programs. It is designed to be very
 -efficient by issuing a very small number of system calls, as one generally
 -wants to update such a status line every second. This ensures that even under
 -high load, your status bar is updated correctly. Also, it saves a bit of energy
 -by not hogging your CPU as much as spawning the corresponding amount of shell
 -commands would.
 +i3status is a small program for generating a status bar for i3bar, dzen2,
 +xmobar, lemonbar or similar programs. It is designed to be very efficient by
 +issuing a very small number of system calls, as one generally wants to update
 +such a status line every second. This ensures that even under high load, your
 +status bar is updated correctly. Also, it saves a bit of energy by not hogging
 +your CPU as much as spawning the corresponding amount of shell commands would.
  
  == CONFIGURATION
  
@@@ -141,7 -142,7 +141,7 @@@ no effect when +output_format+ is set t
  The +interval+ directive specifies the time in seconds for which i3status will
  sleep before printing the next status line.
  
 -Using +output_format+ you can chose which format strings i3status should
 +Using +output_format+ you can choose which format strings i3status should
  use in its output. Currently available are:
  
  i3bar::
@@@ -177,14 -178,14 +177,14 @@@ section just for this module
  
  If you don't fancy the vertical separators between modules i3status/i3bar
  uses by default, you can employ the +separator+ directive to configure how
 -modules are separated. You can either disable the default separator altogether
 +modules are separated. You can also disable the default separator altogether by
  setting it to the empty string. You might then define separation as part of a
  module's format string. This is your only option when using the i3bar output
  format as the separator is drawn by i3bar directly otherwise. For the other
  output formats, the provided non-empty string will be automatically enclosed
  with the necessary coloring bits if color support is enabled.
  
 -i3bar supports Pango markup, allowing your format strings to specify font
 +i3bar supports Pango markup, allowing your format strings to specify font,
  color, size, etc. by setting the +markup+ directive to "pango". Note that the
  ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and
  double-quote (""") characters need to be replaced with "`&amp;`", "`&lt;`",
@@@ -299,21 -300,24 +299,25 @@@ network interface found on the system (
  
  *Example order*: +wireless wlan0+
  
- *Example format*: +W: (%quality at %essid, %bitrate / %frequency) %ip+
+ *Example format_up*: +W: (%quality at %essid, %bitrate / %frequency) %ip+
+ *Example format_down*: +W: down+
  
  === Ethernet
  
  Gets the IP address and (if possible) the link speed of the given ethernet
 -interface. Getting the link speed requires the cap_net_admin capability. Set
 -it using +setcap cap_net_admin=ep $(which i3status)+.
 +interface. If no IPv4 address is available and an IPv6 address is, it will be
 +displayed. Getting the link speed requires the cap_net_admin capability.
 +Set it using +setcap cap_net_admin=ep $(which i3status)+.
  
  The special interface name `_first_` will be replaced by the first non-wireless
  network interface found on the system (excluding devices starting with "lo").
  
  *Example order*: +ethernet eth0+
  
- *Example format*: +E: %ip (%speed)+
+ *Example format_up*: +E: %ip (%speed)+
+ *Example format_down*: +E: down+
  
  === Battery