README en inglés
README-en.md traduce el README entero, con un enlace entre los dos. Los nombres de los pasos y scripts (enlaces, volumen, marcadores...) se dejan en español porque son los que se escriben, y se explica al principio. En el README en español: lo que faltaba en la tabla de sistema/, que enlaces crea las carpetas y deja ~/.ssh en 700, que gnupg recuerda la contraseña una hora, y un párrafo con las líneas mal cortadas. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016UdJsHrbkmzhoCb6TthP2m
This commit is contained in:
parent
03e640f8a0
commit
5fee14ab7f
GPG key ID:
1CFF10953BEE333C
2 changed files with 184 additions and 10 deletions
169
README-en.md
Normal file
169
README-en.md
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
# suckless
|
||||
|
||||
[Español](README.md) · **English**
|
||||
|
||||
My dotfiles for Void Linux: dwm, st, dmenu, slstatus, slock, scroll and
|
||||
clipmenu, plus the session setup (xinitrc, bash, picom, dunst...).
|
||||
Everforest theme and Fira Code font everywhere.
|
||||
|
||||
Scripts, install steps and some folders have Spanish names (`enlaces`,
|
||||
`volumen`, `marcadores`...). They are kept as they are because those are the
|
||||
real names you type; this README explains what each one does.
|
||||
|
||||
## Layout
|
||||
|
||||
| Folder | Contents |
|
||||
|---|---|
|
||||
| `suckless/` | The programs, each with its own `config.h` and patches |
|
||||
| `home/` | Files that go in `~`, at the same path (they are symlinked) |
|
||||
| `sistema/` | Files that go in `/` (acpid, zzz, elogind, udev, sudoers, runit) |
|
||||
| `install.sh` | Installs everything on a fresh Void system |
|
||||
|
||||
## Install
|
||||
|
||||
On a fresh Void install, as your normal user (it asks for sudo when needed):
|
||||
|
||||
git clone ssh://forgejo@ssh.alejandrogs.es/alejandrogs73/suckless.git ~/suckless
|
||||
cd ~/suckless && ./install.sh
|
||||
|
||||
It runs six steps, which can also be run on their own (`./install.sh enlaces`,
|
||||
for example) and repeated safely:
|
||||
|
||||
1. `paquetes` (packages): installs with xbps everything the setup uses.
|
||||
2. `suckless`: builds the programs and installs them in `/usr/local`.
|
||||
3. `enlaces` (links): symlinks every file in `home/` into `~`. If a different
|
||||
file was already there, it is kept as `.bak`. Since they are symlinks,
|
||||
editing `~/.bashrc` edits the repo. It also creates the user folders and
|
||||
sets `~/.ssh` to 700.
|
||||
4. `gtk`: builds the [Everforest GTK](https://github.com/Fausto-Korpsvart/Everforest-GTK-Theme)
|
||||
theme (green, dark, medium palette) in `~/.themes` from a pinned commit,
|
||||
and links it for GTK 4 apps. It fixes the colours of the GTK 2 part (the
|
||||
theme ships Gruvbox ones) and makes the Papirus folders green. Icons are
|
||||
Papirus-Dark everywhere. Qt 5 and Qt 6 apps use qt5ct/qt6ct
|
||||
(`QT_QPA_PLATFORMTHEME` in `.xinitrc`) with the Fusion style and an
|
||||
Everforest palette (`home/.config/qt*ct/`). If a `papirus-icon-theme`
|
||||
update turns the folders blue again, just run this step again.
|
||||
5. `gnupg`: for after copying `~/.gnupg` by hand (from a USB stick, for
|
||||
example). It fixes the permissions, sets `pinentry-gtk` (falls back to
|
||||
curses on a tty), enables gpg's SSH agent, adds the authentication subkeys
|
||||
to `sshcontrol` and caches the passphrase for one hour. `.bashrc` already
|
||||
points `SSH_AUTH_SOCK` at the agent. If `~/.gnupg` does not exist yet, it
|
||||
does nothing.
|
||||
6. `sistema` (system): copies `sistema/` into `/`, enables the runit services
|
||||
(dbus, elogind, polkitd, NetworkManager, bluetoothd, acpid, chronyd, tlp,
|
||||
automontaje, cupsd), removes dhcpcd and wpa_supplicant (NetworkManager
|
||||
already manages the network) and adds the user to the audio, video, input,
|
||||
network, bluetooth and lpadmin (printer management) groups. Files in
|
||||
`sudoers.d` are checked with `visudo` and installed with mode 440.
|
||||
|
||||
Afterwards, log out and back in (for the groups) and run `startx`.
|
||||
|
||||
Nix is not installed: the little that comes from it (webcord) is installed by
|
||||
hand.
|
||||
|
||||
## Rebuilding after changing the config
|
||||
|
||||
cd suckless/dwm && make && sudo make install
|
||||
|
||||
## Updating from upstream
|
||||
|
||||
Each program was imported with `git subtree --squash`:
|
||||
|
||||
git subtree pull --prefix=suckless/dwm https://git.suckless.org/dwm master --squash
|
||||
git subtree pull --prefix=suckless/clipmenu https://github.com/cdown/clipmenu develop --squash
|
||||
|
||||
The rest work like dwm, changing the name in `--prefix` and in the URL.
|
||||
|
||||
## dwm shortcuts
|
||||
|
||||
`Mod` is `Super` (it is `Alt` in stock dwm). Mouse bindings use `Super` too.
|
||||
Only shortcuts that differ from stock dwm or are new are listed; the rest are
|
||||
unchanged. The st, scroll, dmenu and slock shortcuts are untouched.
|
||||
|
||||
### Changed
|
||||
|
||||
| Action | Stock | Now |
|
||||
|---|---|---|
|
||||
| Open a terminal (`st`) | Mod+Shift+Return | Mod+Return |
|
||||
| zoom (move the window to the master area) | Mod+Return | Mod+Shift+Return |
|
||||
| Close window | Mod+Shift+c | Mod+q |
|
||||
| Quit dwm | Mod+Shift+q | Mod+Shift+m |
|
||||
|
||||
### New
|
||||
|
||||
| Shortcut | Action |
|
||||
|---|---|
|
||||
| Mod+v | clipmenu (same palette and font as dmenu) |
|
||||
| Mod+Shift+l | Lock the screen with `slock` |
|
||||
| Mod+n | Show the last notification again (dunst history) |
|
||||
| Mod+Shift+n | Close all notifications |
|
||||
| Mod+Shift+Escape | Session menu: lock, suspend, quit dwm, reboot or power off (the last three ask for confirmation) |
|
||||
| Mod+`-` / Mod+`+` | Shrink / grow the gaps |
|
||||
| Mod+Shift+`+` | Gaps to 0 |
|
||||
| Volume up / down key | Volume ±5% with `wpctl` (100% max) |
|
||||
| Mute key | Mute or unmute the audio |
|
||||
| Mic mute key or Mod+ñ | Mute or unmute the microphone (ñ is the key right of L on a Spanish keyboard) |
|
||||
| Print Screen | Full screenshot with `maim` |
|
||||
| Shift+Print Screen | Screenshot of a region |
|
||||
|
||||
The audio keys (and clicks on VOL in the bar) use the `volumen` script
|
||||
(`home/.local/bin/volumen`): it changes the volume with `wpctl`, refreshes
|
||||
slstatus and shows a notification with the level.
|
||||
|
||||
Screenshots are saved in `~/Images/Screenshots`, copied to the clipboard and
|
||||
shown in a notification.
|
||||
|
||||
## Session
|
||||
|
||||
- Logging in on tty1 starts `startx` automatically (`.bash_profile`); other
|
||||
ttys do not.
|
||||
- `.xinitrc` also starts `gammastep` (warm light from 20:00 to 8:00, with a
|
||||
one-hour transition) and `bateria` (warns at 15 % and, in red, at 5 %; at
|
||||
3 % it suspends with `sudo -n zzz`). Suspend, power off and reboot need no
|
||||
password (`sistema/etc/sudoers.d/energia`).
|
||||
- Screens: `autorandr` lines them up (the laptop one on the left and as
|
||||
primary) at startup and whenever one is plugged or unplugged (udev rule in
|
||||
`sistema/`), then repaints the wallpaper.
|
||||
- Left click on the date in the bar: this month's calendar in a notification
|
||||
(`calendario`), with today in green.
|
||||
- bash: 10 000-entry history, without duplicates and shared between
|
||||
terminals; the prompt shows the git branch (`*` unstaged changes, `+`
|
||||
staged).
|
||||
- `~/.ssh/config` with aliases: `ssh server` and `forgejo`, both through the
|
||||
domain so they work at home and away. No keys in it: gpg-agent provides
|
||||
them.
|
||||
- Firefox bookmarks backup (`marcadores`, started from `.xinitrc`): once a
|
||||
day it uploads to the server the backup Firefox already makes on its own
|
||||
(`bookmarkbackups/*.jsonlz4`), to `/var/storage/PUBLIC/backup_void/marcadores`:
|
||||
`diario/` keeps 7 days and `semanal/` one per week, forever. It only tries
|
||||
when the SSH key is already unlocked (so pinentry never pops up) and
|
||||
retries every hour. `marcadores ya` uploads it right away. To restore:
|
||||
Firefox > Bookmarks > Manage bookmarks > Import and Backup > Restore.
|
||||
- After 30 minutes idle the screen locks with slock (`xss-lock`) and one
|
||||
minute later it turns off.
|
||||
- USB sticks and SD cards: the `automontaje` service (runit, as root) mounts
|
||||
them in `/mnt/LABEL`, or `/mnt/sdXY` if they have no label, and unmounts
|
||||
them when removed, with a notification. FAT, exFAT and NTFS are owned by
|
||||
the user; internal disks are never touched. Before pulling a stick you
|
||||
wrote to, run `sync` (or `sudo umount /mnt/...`).
|
||||
- User folders in English and without accents (`user-dirs.dirs`):
|
||||
Documents, Downloads and Images.
|
||||
|
||||
## Notes
|
||||
|
||||
- The personal config lives in `config.h`. `config.def.h` is the upstream one
|
||||
plus the patches. If a patch changes `config.def.h`, the change has to be
|
||||
copied to `config.h` by hand: `make` only copies it if `config.h` does not
|
||||
exist.
|
||||
- The applied patches are in `suckless/<program>/patches/`.
|
||||
- dwm: fullgaps, restartsig, preserveonrestart, statuscmd-nosignal and
|
||||
swallow.
|
||||
- st: kitty-graphics, alpha, glyph-wide-support and ligatures, in that
|
||||
order. kitty-graphics already includes anysize. glyph-wide-support and
|
||||
the combination with ligatures come from the `graphics-with-patches`
|
||||
branch of [st-graphics](https://github.com/sergei-grechanik/st-graphics),
|
||||
without boxdraw.
|
||||
- st shows images with the kitty graphics protocol; yazi detects it on its
|
||||
own and shows previews without ueberzugpp.
|
||||
- slock is modified by hand (not a patch): clock, date, battery and a bottom
|
||||
bar with the state colour.
|
||||
Loading…
Add table
Add a link
Reference in a new issue