commit bf369a536a889bd726362344324d772e481dede5 from: Brett Fisher date: Thu Jul 9 23:15:45 2026 UTC man/aestel.7, man/browsefiles.1, man/launchprogram.1, man/setbackground.1: Create manual pages. commit - 2ead0ef5fe7414d8e00b502c1ec9f7e7b79d72d6 commit + bf369a536a889bd726362344324d772e481dede5 blob - /dev/null blob + fa6e1db0c5b6d360e2029dc346c4d0424e8539cd (mode 644) --- /dev/null +++ man/aestel.7 @@ -0,0 +1,34 @@ +.Dd July 6, 2026 +.Dt AESTEL 7 +.Os +.Sh NAME +.Nm aestel +.Nd A collection of Lua terminal utilities +.Sh DESCRIPTION +.Nm +is a collection of lightweight, modular utilities for terminal-based +workflow, productivity, knowledge management, and system administration. + +The scripts rely on a shared set of Lua modules. + +.Bl -tag -width 15n -compact +.It browse.lua +Browsing directory structure and content. +.It colors.lua +Shared ANSI color constants. +.It display.lua +Shared terminal output display. +.It input.lua +Shared low-level terminal input utilities. +.It menu.lua +Rendering and navigating menus. +.It opener.lua +Opening files based on MIME type. +.El +.Sh SEE ALSO +.Xr browsefiles 1 , +.Xr launchprogram 1 , +.Xr setbackground 1 +.Sh AUTHOR +.An Brett Fisher + blob - /dev/null blob + 43f33b2daa70728b720d55bb3c6e16a280b9a2a3 (mode 644) --- /dev/null +++ man/browsefiles.1 @@ -0,0 +1,52 @@ +.Dd July 6, 2026 +.Dt BROWSEFILES 1 +.Os +.Sh NAME +.Nm browsefiles +.Nd directory browsing and file opening utility +.Sh SYNOPSIS +.Nm +.Ar [directory] +.Sh DESCRIPTION +.Nm +is a keyboard-driven file browser designed for terminal-based workflows. +The script provides navigation of the filesystem and automatic opening +of files based on their MIME type. +.Pp +When invoked without an argument, the script starts in the current +working directory, or defaults to the user's home directory. +.Sh KEYBINDINGS +.Bl -tag -width 12n -compact +.It Ic j / Down +Move highlight down the list. +.It Ic k / Up +Move highlight up the list. +.It Ic h / Left +Navigate to the parent directory. +.It Ic l / Right +Enter directory or open file. +.It Ic . +Toggle visibility of hidden files. +.It Ic q +Quit the application. +.El +.Sh NOTES +.Nm +associates files with applications based on their MIME type. The +supported handlers are opinionated; the author utilizes specific C, +language, minimal applications. + +Only pre-configured file types are supported. Files with unknown MIME +types will not trigger an action. Customization of these associations +can be made by modifying +.Pa aestel/opener.lua . +.Sh ENVIRONMENT +.Bl -tag -width 12n -compact +.It Ev HOME +Browsing is restricted to the user's HOME directory. +.El +.Sh SEE ALSO +.Xr aestel 7 +.Sh AUTHOR +.An Brett Fisher + blob - /dev/null blob + 3ddcb08f0f516fa9febcfc3b28f7b1fe8c046af2 (mode 644) --- /dev/null +++ man/launchprogram.1 @@ -0,0 +1,39 @@ +.Dd July 6, 2026 +.Dt LAUNCHPROGRAM 1 +.Os +.Sh NAME +.Nm launchprogram +.Nd menu-driven program launcher +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +.Nm +is a simple, keyboard-driven utility used to launch preferred +applications or scripts. The utility provides a scrollable menu of +available tasks and executes the selected item. +.Sh KEYBINDINGS +.Bl -tag -width 12n -compact +.It Ic j / Down +Move highlight down the menu. +.It Ic k / Up +Move highlight up the menu. +.It Ic Enter / l / Right +Launch the selected program. +.It Ic q +Quit the application. +.El +.Sh NOTES +.Nm +contains a hardcoded list of programs and scripts tailored to the +author's personal workflow. Because this tool is specific to the +user's environment, the list is intended to be customized. Users are +encouraged to modify the command table within +.Pa bin/launchprogram.lua +to include your their preferred programs and scripts. +.Sh SEE ALSO +.Xr aestel 7 , +.Xr browsefiles 1 , +.Xr setbackground 1 +.Sh AUTHOR +.An Brett Fisher + blob - /dev/null blob + bb19e347bd88134ab9cfbb24bfdf606dc2a38303 (mode 644) --- /dev/null +++ man/setbackground.1 @@ -0,0 +1,49 @@ +.Dd July 6, 2026 +.Dt SETBACKGROUND 1 +.Os +.Sh NAME +.Nm setbackground +.Nd background setting utility +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +.Nm +is an interactive, menu-driven utility for browsing and setting +screen backgrounds (wallpapers). The script leverages the directory +and file browsing capabilities of the aestel utilities to locate +image files within a designated directory and apply them using the +configured background-setting tool. +.Sh KEYBINDINGS +.Bl -tag -width 12n -compact +.It Ic j / Down +Move highlight down the list. +.It Ic k / Up +Move highlight up the list. +.It Ic h / Left +Navigate to the parent directory. +.It Ic l / Right +Enter directory or select image to set background. +.It Ic . +Toggle visibility of hidden files. +.It Ic q +Quit the application. +.El +.Sh NOTES +.Nm +defaults to the use of +.Xr bgs 1 +as the backend for setting background images. The command string in +.Pa bin/setbackground.lua may be customized if an alternate background +or wallpaper setting tool is preferred. +.Sh FILES +.Bl -tag -width 12n -compact +.It Pa ~/.local/share/backgrounds +The default directory where this utility scans for images. +.El +.Sh SEE ALSO +.Xr aestel 7 , +.Xr browsefiles 1 , +.Xr launchprogram 1 +.Sh AUTHOR +.An Brett Fisher +