gscripts/Readme.md
Robert Morrison f4a84d9358
feat(blogv): Add blogv
Add blogv the dumb build log viewer to the repo
NOTE: I also remove the extraneous readme.html that accidentally got
committed
2024-08-16 02:09:41 +01:00

72 lines
2.1 KiB
Markdown

# GScripts
A set of scripts which I use in my current Gentoo system,
all are installed through portage and of course are tested to work on my
system and my system alone.
Where possible I only use dependencies available in the main Gentoo repo
and each script has the dependencies listed.
All scripts are licensed under the MIT (Expat) License (for more
information on why I give two names for one license please see
[what the GNU project has to say on the matter](https://www.gnu.org/licenses/license-list.en.html#Expat))
I intentionally use the term MIT license as that is the accepted SPDX
license identifier.
_Coming Eventually:_
A portage repo that contains my ebuilds (where I am certain of the accuracy
of the license data).
Where scripts have configuration all environment variables are
pseudo-namespaced by `$GScripts_<OPTION>`
## The Scripts
### WallChooser
A simple script that lets you pick a new wallpaper, it automatically runs
all the required steps to generate a new `pywal` theme and set the
wallpaper using `swww`
#### Requirements
- `fzf`
- `swww`
- `wal`
- `bemenu`
### BarRunner
A tool to run `waybar`, Automatically restarting the bar if any of the
required config files are changed.
NOTE: This tool is very much designed around my system and will likely fail
to operate properly for you.
It is designed with special handling for different compositors. And
compatibility with `pywal`
#### Arguments
- `$1` The name of the compositor
- `$2` Use `pywal`? (y|Y|yes triggers pywal support)
#### Requirements
- `waybar`
- `inotifywait`
### blogv
A simple and naive script to read build log entries.
Really just a bunch of pipes in a shellscript file so it has a name.
Heavily depends on portage build logs being done in a specific way
```bash
## Portage logging
PORTAGE_ELOG_CLASSES="info warn error log qa"
PORTAGE_ELOG_SYSTEM="echo save"
PORTAGE_LOGDIR="/var/log/portage"
PORTAGE_LOG_FILTER_FILE_CMD="bash -c \"ansifilter; exec cat\""
PORTAGE_LOGDIR_CLEAN="find "${PORTAGE_LOGDIR}" -type f ! -name "summary.log*" -mtime +30 -delete"
## Change some features
FEATURES="clean-logs \
split-elog \
split-log "
```
#### Requirements
- `fzf`
- `xargs`
- `bat`