Dotfiles Documentation
Total Page:16
File Type:pdf, Size:1020Kb
dotfiles Documentation Release 0.9.0 Wes Turner April 29, 2016 Contents 1 Dotfiles 1 1.1 Goals...................................................1 1.2 Installation................................................1 1.2.1 Requirements..........................................1 1.2.2 Install the dotfiles........................................1 1.2.3 Source the dotfiles.......................................2 1.2.4 Upgrade the dotfiles.......................................3 1.3 Quickstart................................................4 1.4 Further Dotfiles Resources........................................5 2 Usage 7 2.1 bootstrap_dotfiles.sh...........................................7 2.2 Makefile.................................................7 2.3 Readline.................................................7 2.4 Bash...................................................9 2.5 ZSH.................................................... 30 2.6 I3wm................................................... 31 2.7 Vim.................................................... 35 2.8 src/.................................................... 48 2.8.1 pgs................................................ 48 2.8.2 pyline.py............................................ 49 2.8.3 pyrpo.py............................................. 49 2.8.4 web.sh.............................................. 49 2.9 Scripts.................................................. 49 2.9.1 dotfiles............................................. 50 bootstrap_dotfiles.sh....................................... 50 2.9.2 venv............................................... 50 venv.py.............................................. 50 venv_relabel.sh.......................................... 50 venv_root_prefix.sh........................................ 50 venv.sh.............................................. 50 _ewrd.sh............................................. 50 _dotfileshelp.sh.......................................... 50 gitw................................................ 51 _grinwrd.sh............................................ 51 makew.............................................. 51 usrlog.sh............................................. 52 usrlog.py............................................. 52 i 2.9.3 git................................................ 52 .gitconfig............................................. 52 .gitignore_global......................................... 55 gittagstohgtags.sh......................................... 55 git-changelog.py......................................... 55 git-subrepo2submodule.sh.................................... 55 git-track-all-remotes.sh...................................... 56 git-upgrade-remote-to-ssh.sh................................... 56 2.9.4 hg................................................ 56 .hgrc............................................... 56 .hgignore_global......................................... 60 2.9.5 bashmarks_to_nerdtree.sh................................... 60 2.9.6 compare_installed.py...................................... 61 2.9.7 pulse.sh............................................. 61 2.9.8 setup_mathjax.py........................................ 61 2.9.9 setup_pandas_notebook_deb.sh................................ 61 2.9.10 setup_pandas_notebook.sh................................... 61 2.9.11 setup_scipy_deb.py....................................... 61 2.9.12 deb_deps.py........................................... 61 2.9.13 deb_search.py.......................................... 61 2.9.14 build_docs.py.......................................... 61 2.9.15 el................................................ 62 2.9.16 greppaths.py........................................... 62 2.9.17 lsof.py.............................................. 62 2.9.18 mactool.py........................................... 62 2.9.19 optimizepath.py......................................... 62 2.9.20 passwordstrength.py...................................... 62 2.9.21 pipls.py............................................. 63 2.9.22 pycut.py............................................. 63 2.9.23 py_index.py........................................... 63 2.9.24 pyren.py............................................. 63 2.9.25 whyquote.sh........................................... 63 2.9.26 xlck.sh.............................................. 63 3 Usage (dhelp) 65 3.1 scripts/_dotfileshelp.sh.......................................... 65 3.2 scripts/bootstrap_dotfiles.sh....................................... 66 3.3 etc/.inputrc................................................ 68 3.4 etc/bash/00-bashrc.before.sh....................................... 69 3.5 etc/bash/01-bashrc.lib.sh......................................... 72 3.6 etc/bash/02-bashrc.platform.sh...................................... 72 3.7 etc/bash/03-bashrc.darwin.sh...................................... 72 3.8 etc/bash/04-bashrc.TERM.sh...................................... 73 3.9 etc/bash/05-bashrc.dotfiles.sh...................................... 73 3.10 etc/bash/06-bashrc.completion.sh.................................... 74 3.11 etc/bash/07-bashrc.python.sh...................................... 74 3.12 etc/bash/07-bashrc.virtualenvwrapper.sh................................. 75 3.13 etc/bash/08-bashrc.conda.sh....................................... 75 3.14 etc/bash/08-bashrc.conda.sh.un~..................................... 76 3.15 etc/bash/08-bashrc.gcloud.sh....................................... 77 3.16 etc/bash/10-bashrc.venv.sh........................................ 78 3.17 etc/bash/11-bashrc.venv.pyramid.sh................................... 79 3.18 etc/bash/20-bashrc.editor.sh....................................... 79 3.19 etc/bash/29-bashrc.vimpagers.sh..................................... 80 ii 3.20 etc/bash/30-bashrc.usrlog.sh....................................... 80 3.21 etc/bash/30-bashrc.xlck.sh........................................ 80 3.22 etc/bash/40-bashrc.aliases.sh....................................... 81 3.23 etc/bash/42-bashrc.commands.sh.................................... 82 3.24 etc/bash/50-bashrc.bashmarks.sh.................................... 83 3.25 etc/bash/70-bashrc.repos.sh....................................... 83 3.26 etc/bash/99-bashrc.after.sh........................................ 85 3.27 etc/bash/_ewrd.sh............................................ 85 3.28 etc/bash/usrlog.sh............................................ 86 3.29 etc/bash/xlck.sh............................................. 89 3.30 etc/zsh/00-zshrc.before.sh........................................ 89 3.31 etc/zsh/01-zshrc.lib.sh.......................................... 90 3.32 etc/zsh/05-zshrc.bashrc.sh........................................ 90 3.33 etc/zsh/99-zshrc.after.sh......................................... 90 3.34 etc/i3/config............................................... 90 3.35 etc/vim/vimrc............................................... 94 3.36 etc/vim/vimrc.full.bundles.vimrc.................................... 100 3.37 etc/vim/vimrc.tinyvim.bundles.vimrc.................................. 106 4 venv 109 4.1 Working With Venv........................................... 109 4.1.1 CdAlias............................................. 110 4.1.2 venv.py............................................. 112 Python API............................................ 113 4.1.3 Example Venv Configuration.................................. 114 Shell Configuration........................................ 114 JSON Configuration....................................... 115 4.2 Other scripts with venv-style paths.................................... 117 5 usrlog 119 5.1 usrlog.sh................................................. 119 5.1.1 Installation........................................... 119 5.1.2 Features............................................. 119 usrlog venv integration...................................... 120 5.1.3 -usrlog.log format........................................ 121 -usrlog.log natural key...................................... 121 5.2 usrlog.py................................................. 121 5.3 Caveats.................................................. 122 5.4 Ideas................................................... 122 6 Dotfiles API 125 6.1 Subpackages............................................... 125 6.1.1 dotfiles.cli package....................................... 125 Submodules............................................ 125 dotfiles.cli.cli module....................................... 125 6.1.2 dotfiles.venv package...................................... 126 Objectives............................................. 126 Configuration........................................... 126 Submodules............................................ 127 dotfiles.venv.ipython_config module............................... 127 dotfiles.venv.ipython_magics module.............................. 141 dotfiles.venv.venv module.................................... 144 dotfiles.venv.venv_ipyconfig module............................... 158 dotfiles.venv.venv_ipymagics module.............................. 172 iii 7 Developing 175 7.1 Create a virtualenv with virtualenvwrapper............................... 175 7.2 Install this package............................................ 175 7.3 Test and build this package........................................ 175 8 Changelog 177 8.1 0.9.0................................................... 177 8.2 0.8.3................................................... 179 8.3 0.8.2..................................................