From 7f9a34daa905c8e182c261d7b4ead83e5a502e82 Mon Sep 17 00:00:00 2001 From: Luke Date: Fri, 9 Jun 2017 16:18:35 -0400 Subject: [PATCH] Documentation additions and more --- .config/Scripts/aurinstall.sh | 5 ---- .config/mutt/luke_mutt_readme_2.md | 27 ++++++++++++++++++++ .config/mutt/mutt.sh | 4 --- README.md | 40 ++++++++++++++++++++++++++++++ install_dependencies.sh | 2 +- 5 files changed, 68 insertions(+), 10 deletions(-) delete mode 100644 .config/Scripts/aurinstall.sh create mode 100644 .config/mutt/luke_mutt_readme_2.md delete mode 100644 .config/mutt/mutt.sh diff --git a/.config/Scripts/aurinstall.sh b/.config/Scripts/aurinstall.sh deleted file mode 100644 index 94733882..00000000 --- a/.config/Scripts/aurinstall.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash -wget https://aur.archlinux.org/cgit/aur.git/snapshot/$1.tar.gz -tar -xvzf $1.tar.gz -cd $1 && makepkg --no-confirm -si -cd .. && rm -rf $1 $1.tar.gz diff --git a/.config/mutt/luke_mutt_readme_2.md b/.config/mutt/luke_mutt_readme_2.md new file mode 100644 index 00000000..c7e16e69 --- /dev/null +++ b/.config/mutt/luke_mutt_readme_2.md @@ -0,0 +1,27 @@ +# Luke's mutt readme, Part 2: Offline IMAPS + +Here was my goal: + ++ Have an extensible terminal based email client that can store all of my emails offline for access when I don't have internet. + +This is important, not just for general convenience, but because I don't have internet for most of the day. + +## OfflineIMAPS + +OfflineIMAPS keeps a local repo of your IMAP emails on your own machine. I've done the setup in this rice for you, you just have to fill in your account info. + +## Setup + +Look up your server info for your email provider. The details will be on their website. + +First go to `~/.offlineimaprc`. I have a template for a Gmail account there already. You can simply add your username and password in the required locations. You can add or replace the gmail account with any other kind of email account as well, just instead of `type = Gmail`, use `type = IMAP` in the remote repository. Note that each email account will have a general settings category, marked [Account NAME] and two sub repositories, one being the online repo and the other being a directory on your own machine, marked [Repository NAME-remote] and [Repository NAME-local]. To add new accounts mimic the syntax I have. + +Then either run `offlineimap -o` and if your information was entered correctly, OfflineIMAP will begin to download *all* of your email (which may take a while). + +Next add your account and (SMTP) server info to `~/.msmtp`. This will allow you to send emails. + +## How to keep synced + +Each time you run `offlineimap`, mail will be synced between the internet and your own machine. I don't have a systematized way to run this, but `~/.config/Scripts/mailsyncloop.sh` is aliased to `mailsync` and will updateOfflineIMAP every couple of minutes or so. There are smarter ways to do this, and if you develop one, feel free to tell me! + +[luke@lukesmith.xyz](mailto:luke@lukesmith.xyz) diff --git a/.config/mutt/mutt.sh b/.config/mutt/mutt.sh deleted file mode 100644 index 537322ee..00000000 --- a/.config/mutt/mutt.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash -pwds='gpg --decrypt ~/.config/Scripts/DELET' -eval "$pwds" -exec mutt -F ~/.config/mutt/muttrc "$@" diff --git a/README.md b/README.md index c2093ae1..94b4f86c 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,49 @@ These are the files to my Void Linux Rice. + compton (For transparency and to stop screen tearing) + And many little scripts I use +## More documentation + +Check other config folders for more specific documentation. For example [config mutt](.config/mutt/) contains documentation on how to set up mutt with your email account. + +## Dynamic Configuration Files + +One of the most notable parts of my setup is that my ~/.bashrc and configs for ranger and qutebrowser are dynamically synchronized with by `~/.config/Scripts/shortcuts.py`. Each config file has a "base" form to which directory shortcuts are added and synchronized every time i3 refreshes or when you press Super+F2. + +Each of these programs have shortcuts to edit config files and to go to or move files to certain directories. Each time `shortcuts.py` is run, the pairs in both `~/.config/Scripts/folders` and `~/.config/Scripts/configs` are put in the syntax of each application and the + +### What does this mean? + +1. You can easily add directory shortcuts in `~/.config/Scripts/folders` (just type cff in bash) or aliases to configs in `~/.config/Scripts/configs` (just type cfc in bash). +2. Each time you run `shortcuts.py`, this script takes the input from the above files and puts it in the required syntax for bash, ranger and qutebrowser. +3. This keeps all your configs in sync and you can use the same shortcuts in each program and allows you to add more easily as you need them for your folder structure. + +**Note: to have persistent changes in bash or ranger configs, be sure to edit not ~/.bashrc (which is replaced each time), but ~/.config/Scripts/bashrc, which is the base that `shortcuts.py` builds off of.** There is already the alias of `cfb` to edit this file. **Just remember to run `shortcuts.py` (Super+F2) after to apply the changes.** + +### That's confusing! + +Then simply remove the line in the i3 config that runs `shortcuts.py` and then edit configs as usual. + +## ~/.config Centrality + +Some programs, like mocp, tmux, mutt, calcurse and weechat look to `~` and not `~/.config` for their dotfiles. This annoys me since I like using Syncthing to sync my config files accross machines. + +To avoid this, I have bash aliases and i3 shortcuts that run these programs looking in `~/.config/` instead for their files. This makes managing files easier for me. + +You can easily change this if you want. As I decrease the number of machines I use anyway, I may gradually stop doing this. + ## Differences from my Arch and Parabola Rices + **Since Void is more or less my main distro now, this repo is more likely to get updates over time.** The Arch and Parabola repos may get some, changes, but will remain mostly the same. + Void uses a different pacakge manager and init system than Arch/Parabola, thus some of the relevant shortcuts have been changed. + This rice uses ALSA only, and **not** PulseAudio. This makes for a more minimal system, but there is some functionality of the Parabola rice not present here yet, specifically, I don't have a way of recording system sounds yet, or using music visualizers. If you have more experience than me in getting these to work, please email me your solution! [luke@lukesmith.xyz](mailto:lukesmith.xyz) + I use only Firefox on my Void Machine, not qutebrowser, so there are no qutebrowser configs here. + +## Note on dependencies + +As of now, I've listed most of the dependencies in a script in the main directory. I don't think list is exhaustive, so if you find another program that my rice requires, please notify me so I can add it for the facility of other users! Again, my mail is at [luke@lukesmith.xyz](mailto:luke@lukesmith.xyz). + +## Like my rice? + +Feel free to add other suggestions and I may implement them. + +I have a job, but every penny I get from followers or subscribers is more incentive to perfect what I'm doing. You can donate to me at [https://paypal.me/LukeMSmith](https://paypal.me/LukeMSmith). Donations are earmarked for whatever the donator wants, usually to go to funds for buying new equipment for the [YouTube channel](https://youtube.com/c/LukeSmithxyz). diff --git a/install_dependencies.sh b/install_dependencies.sh index f15d916e..5ad3256f 100644 --- a/install_dependencies.sh +++ b/install_dependencies.sh @@ -2,7 +2,7 @@ # I don't think this list is everything, please tell me if you find anything missing. -xbps-install xorg-minimal xorg-fonts xf86-input-synaptics xf86-video-intel base-devel xinit xorg-server rxvt-unicode feh ffmpeg arandr mpv wget curl rofi python-pip python-netifaces python-psutil NetworkManager network-manager-applet vim w3m ranger mediainfo poppler highlight tmux calcurse htop newsbeuter moc firefox qutebrowser ImageMagick transmission-gtk transmission atool libcaca compton transset blender gimp texlive MultiMarkdown mupdf evince audacity rsync youtube-dl openssh syncthing noto-fonts-cjk noto-fonts-emoji cups screenFetch neofetch scrot unzip git lmms p7zip font-tamsyn speedometer neomutt font-awesome mypaint pandoc xdotool +xbps-install xorg-minimal xorg-fonts xf86-input-synaptics xf86-video-intel base-devel xinit xorg-server rxvt-unicode feh ffmpeg arandr mpv wget curl rofi python-pip python-netifaces python-psutil NetworkManager network-manager-applet vim w3m ranger mediainfo poppler highlight tmux calcurse htop newsbeuter moc firefox qutebrowser ImageMagick transmission-gtk transmission atool libcaca compton transset blender gimp texlive MultiMarkdown mupdf evince audacity rsync youtube-dl openssh syncthing noto-fonts-cjk noto-fonts-emoji cups screenFetch neofetch scrot unzip git lmms p7zip font-tamsyn speedometer neomutt font-awesome mypaint pandoc xdotool unclutter-xfixes tlmgr info collections | grep -o 'collection-[A-Za-z]*' | zargs tlmgr install