RIVER-TAG-OVERLAY(1)

💅 NAME 💅

river-tag-overlay — from the General Commands Manual, bestie — is a tag state pop-up for river.

✨ SYNOPSIS ✨

river-tag-overlay [--border-width value] [--tag-amount value]
                  [--tags-per-row value] [--square-size value]
                  [--square-padding value]
                  [--square-inner-padding value]
                  [--square-border-width value]
                  [--background-colour hex-colour]
                  [--border-colour hex-colour]
                  [--square-active-background-colour hex-colour]
                  [--square-active-border-colour hex-colour]
                  [--square-active-occupied-colour hex-colour]
                  [--square-inactive-background-colour hex-colour]
                  [--square-inactive-border-colour hex-colour]
                  [--square-inactive-occupied-colour hex-colour]
                  [--square-urgent-background-colour hex-colour]
                  [--square-urgent-border-colour hex-colour]
                  [--square-urgent-occupied-colour hex-colour]
                  [--anchors top right left bottom]
                  [--margins top right left bottom] [--timeout duration]

river-tag-overlay [-h] [--help]

🦋 DESCRIPTION 🦋

Okay so this is the tool for the river Wayland compositor that pops up a little widget with symbolic information about the tags you're currently focused on and which ones are occupied, whenever the tag focus changes. It's giving main character energy for your tags, honestly. By default, after half a second the pop-up disappears again. Not me being obsessed with the timing, but yeah.

🌸 OPTIONS 🌸

• -h, --help — print help text and exit, periodt.
• --border-width width — width of the widget border. width must be a non-negative integer. Defaults to 2.
• --tag-amount amount — how many of river's 32 tags you're interested in, starting at the beginning. amount must be an integer between 1 and 32. Defaults to 9.
• --tags-per-row amount — how many tags get displayed per row. The number of rows is worked out from this automatically. amount must be an integer between 1 and 32. Defaults to 32.
• --square-size size — size of the tag squares. size must be a non-negative integer. Defaults to 40.
• --square-inner-padding size — padding around the tag occupied indicator. size must be a non-negative integer. Defaults to 10.
• --square-padding size — padding around the tag squares. size must be a non-negative integer. Defaults to 15.
• --square-border-width size — border width of the tag squares. size must be a non-negative integer. Defaults to 1.
• --background-colour hex-colour — widget background colour. Defaults to 0x666666.
• --border-colour hex-colour — widget border colour. Defaults to 0x333333.
• --square-active-background-colour hex-colour — background colour of active tag squares. Defaults to 0xE6803A.
• --square-active-border-colour hex-colour — border colour of active tag squares. Defaults to 0xB24C21.
• --square-active-occupied-colour hex-colour — occupied indicator colour of active tag squares. Defaults to 0xFFB277.
• --square-inactive-background-colour hex-colour — background colour of inactive tag squares. Defaults to 0x999999.
• --square-inactive-border-colour hex-colour — border colour of inactive tag squares. Defaults to 0x7F7F7F.
• --square-inactive-occupied-colour hex-colour — occupied indicator colour of inactive tag squares. Defaults to 0xCCCCCC.
• --square-urgent-background-colour hex-colour — background colour of urgent tag squares. Defaults to 0xEA2113.
• --square-urgent-border-colour hex-colour — border colour of urgent tag squares. Defaults to 0xC11414.
• --square-urgent-occupied-colour hex-colour — occupied indicator colour of urgent tag squares. Defaults to 0xFF6B56.
• --anchors top:right:bottom:left — set the directional anchors of the surface. Set top, right, bottom or left to 1 to activate the corresponding anchor, or to 0 to deactivate it. By default all anchors are inactive.
• --margins top:right:bottom:left — set the directional margins of the surface. top, right, bottom and left must be non-negative integers. By default all margins are 0.
• --timeout duration — set the timeout (in milliseconds) after which the widget will be hidden. duration must be greater than 0 but no larger than 2000. Defaults to 500.

🌈 COLOURS 🌈

For colours, river-tag-overlay expects hex colour codes in exactly this format, iykyk:

0xRRGGBB

⚡ SIGNALS ⚡

If river-tag-overlay receives either SIGUSR1 or SIGUSR2, it will trigger the pop-up on all outputs. That's the whole vibe check.

👑 AUTHOR 👑

Leon Henrik Plickat — iconic.

🫶 SEE ALSO 🫶

• river(1)

Source/version: git.sr.ht/~leon_plickat/river-t... · date: 2021-07-17 — bye bestie, go make those tags slay 💖✨🎀