elkowar
[FEATURE] any chance for a man page?
Description of the requested feature
preferably with examples and snippets of uses.
Proposed configuration syntax
No response
Additional context
No response
I'm not sure why this would be needed? Digital documentation is available here, a man page would be more even more work.
I've actually considered having a man-page in the past -- however, maintaining a man page in addition to the current documentation would bring a good bit of extra effort, for questionable benefit. If someone could come up with a good way to auto-generate a man page from the current docs, I'd be happy to consider that, though!
Google Gemini thinks it may look like this:
EWW(1) NAME eww - ElKowar's Wacky Widgets, a widget system for Linux.
SYNOPSIS eww [OPTIONS] SUBCOMMAND [ARGS...]
Common Subcommands: eww open WINDOW_NAME [--no-daemon]
eww close WINDOW_NAME
eww update VARIABLE=VALUE [...]
eww reload
eww kill
eww daemon
eww logs
eww windows
eww debug
DESCRIPTION Eww, short for ElKowar's Wacky Widgets, is a lightweight, fast, and highly customizable widget manager written in Rust. It enables users to create dynamic and interactive graphical elements directly on their desktop, such as status bars, system monitors, notification pop-ups, and more. Eww is designed to be independent of any specific window manager and supports both Wayland and X11 display servers.
Its core strength lies in its declarative configuration language, Yuck, which uses a Lisp-like syntax to define the layout, appearance, and behavior of widgets. Theming is handled with standard CSS. Eww can execute external commands and react to system events, making it an indispensable tool for building personalized and functional desktop setups.
OPTIONS
-c, --config PATH
Specifies an alternative path to the eww configuration directory. By default, eww looks in $XDG_CONFIG_HOME/eww or ~/.config/eww.
--log-level LEVEL
Sets the verbosity of the logging output. Possible values include trace, debug, info, warn, and error.
--no-daemon When used with the open subcommand, this option prevents eww from running as a background daemon, keeping it in the foreground.
SUBCOMMANDS open Opens a window. If the eww daemon is not running, it will be started automatically unless --no-daemon is specified.
close Closes a specific window.
update Updates the value of one or more eww variables. The variables are defined in the configuration file and can be used to display dynamic information in widgets.
reload Reloads the configuration file, allowing changes to take effect without restarting the daemon.
kill Terminates the running eww daemon.
daemon Starts the eww daemon. This is useful for starting the daemon independently of any windows.
logs Prints and follows the logs from the eww daemon. Useful for debugging configuration issues.
windows Lists all currently open eww windows.
debug Provides detailed debugging information about the current state of eww.
FILES $XDG_CONFIG_HOME/eww or ~/.config/eww/ The default directory for eww's configuration files, including the main eww.yuck file and associated CSS files.
EXAMPLES Open a window named my_bar:
eww open my_bar
Reload the configuration after making changes:
eww reload
Update a variable named cpu_usage:
eww update cpu_usage=95
Start the daemon and open a window in a single line:
eww daemon && eww open main_window
AUTHORS Written by ElKowar.
BUGS Report bugs at the official GitHub repository: https://github.com/elkowar/eww
