dot/README.md

59 lines
2 KiB
Markdown

# dot
Yet another dotfiles repo! Files are organized by hostname and maintained by [update.sh](./update.sh)
A _relatively_ recent Linux desktop is assumed throughout; PRs are always welcome!
_I use Fedora btw :)_
## Notable entries
### i3/Sway auto-start script
_Script:_ [.config/sway/scripts/startup.py](./outerheaven.init3.home/.config/sway/scripts/startup.py)
_Config:_ [~/.config/autostart-i3ipc.yml](./outerheaven.init3.home/.config/autostart-i3ipc.yml)
Time/date aware _(conditional)_ autostart manager for Sway/i3 window managers.
Should run on-login:
```bash
~ $ cat ~/.config/sway/config
# Config for sway
#
# See `man 5 sway` for a complete reference.
# [...]
# run script which handles conditional/timely autostarts. uses dict w/ this structure:
# {'autostarts': { 'pre': [], 'weekend': [], 'common': [], 'work': []}}
exec 'python3 ~/.config/sway/scripts/startup.py'
```
Config example with in-line comments:
```yaml
---
autostarts:
pre: [] # *always* run, before/blocking others. ie: backup
weekend: [] # blocking Sat/Sun. after 'pre'/before 'common'. ie: backup tier 2
common: [] # things started every day, after 'pre' - non-blocking
work: [] # does not execute on weekends; only if within working day/hours
```
Touch `~/.vacation` to skip `work` autostarts; `rm` when work may continue :)
Working days are assumed Monday through Friday. Hours are between 8 AM and 4 PM.
These parameters may be changed in the `WorkTime` class.
### homedir backup script
_Script:_ [~/.local/bin/backup_home](./outerheaven.init3.home/.local/bin/backup_home)
_Config:_ `~/.restic_excludes`
This will back up `$HOME`_(minus exclusions, of course)_; part of [the auto-starts]
(#i3sway-auto-start-script)
The meaningful work is given away, coordinating _[on-login]_:
* `restic`: performs the backup
* `pass`: stores the passphrase given to `restic`; confirmation on hardware token
The exclusions file is highly personalized, and as such, _not_ included. Should be _shell patterns_ split by lines.