easyconf-lemonbar/example_config.yml

# Example config file for easyconf-lemonbar. Default values are shown, except
# where indicated.
bar:
  # Global configuration options. These are mostly flags passed to lemonbar at
  # runtime.
  config:
    # Define a custom size of the bar. By default, this is different for every
    # screen, so the format is shown below.
    geometry: 'widthxheight+x+y'
    # Dock the bar at the bottom of the screen.
    bottom: false
    # Force the bar to dock (if your window manager is weird).
    force: false
    # Font of display text. The default font is set by the system, and what
    # fonts you can use depends on what your version of lemonbar supports. See
    # `man lemonbar` for more info. You may define up to 5 fonts; they will be
    # assigned an index value 1-5 in the order you specify them (this will be
    # relevant later). The first font you list will be the default font for the
    # bar. The basic format is shown below.
    font: 'Font Name-Size'
    #font: 'Second Font Name-Size' etc...
    # Set a custom Xorg WM_NAME.
    name: 'bar'
    # Under/overline thickness in pixels.
    line_thickness: 1
    # Background color of the bar.
    bg_color: '#000'
    # Color of text.
    fg_color: '#FFF'
    # Vertical offset of the text in pixels (can be negative).
    offset: 0
    # Global under/overline color.
    line_color: '#FFF'
    # Padding to the right and left of the text of any module. Formatting is
    # applied to the padding, too.
    padding: ' '
    # Seperator between modules. Module formatting options are not applied to
    # the seperator.
    seperator: '|'

  # Here is where you can define your individual modules. You can define as
  # many modules as you want. Some fields are required; these will be indicated.
  # If a field doesn't say its required, you can safely omit it in your own
  # configuration. A "bare minimum" configuration is shown below for your
  # convience.
  modules:
    # This is an example module. You can name it whatever you want, it doesn't
    # matter.
    example_module:
      # This command is run by `sh -c`, and whatever is sent to stdout is the
      # text that will be displayed for this module. `date` here is used as an
      # example. THIS IS A REQUIRED FIELD.
      command: 'date'
      # How often to re-run the command and display the updated text. THIS IS A
      # REQUIRED FIELD.
      refresh: 1000
      # Prefix to be printed before the text of the command.
      prefix: 'DATE: '
      # Formatting options. These will only affect the text and padding of this
      # module.
      format:
        # Where the text should be placed on the bar. `left`, `right`, or
        # `center`. THIS IS A REQUIRED FIELD.
        align: left
        # Background color of the bar.
        bg_color: '#000'
        # Text color
        fg_color: '#FFF'
        # INDEX of the font for this module to be displayed in (see above).
        font: 1
        # Set an underline or overline
        line: 
          # Self-explanatory. `underline` or `overline`. IF you set a line, then
          # this is a required field.
          type: underline 
          # Set a custom color for the line.
          color: '#000'
        # Make this module act like a button. Both of these fields are required
        # if you are making a button. You may also define multiple buttons with
        # different activators for a single module.
        button:
          # What mouse click you have to make to activate the button. Can be
          # `left`, `center`, or `right`. You can also set it to activate when
          # you scroll up or down with `scrup` and `scrdown.`
          activator: left
          # Command to be executed upon activation. Will be run with `sh -c`.
          command: 'echo "hello" > ~/file.txt'

    # Here is a simpler example module showing only the required fields.
    bare_minimum:
      command: 'whoami'
      refresh: 1000
      format:
        align: right