extern/nix-config
1
0
Fork 1
mirror of https://github.com/donovanglover/nix-config.git synced 2024-11-21 15:53:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update READMEs for ssh-agent, vim, and xmodmap

Browse Source 
This completes the process of updating all the old READMEs
to the new format.
This commit is contained in:
Donovan Glover 2018-11-23 00:12:40 -05:00
parent 5679c7092c
commit 0db520b429
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
3 changed files with 42 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
ssh-agent/README.md
View File

@ -1,16 +1,16 @@
# ssh-agent
SSH is used to connect to remote machines. I use a systemd service to manage ssh-agent.
[SSH][ssh] is used to connect to remote machines. I use a systemd service to manage ssh-agent.
## Dependencies
## Use Cases
- [openssh][openssh] - SSH support
ssh-agent can be used to:
## Installation
- Hold private keys
```sh
make package=ssh-agent
```
You should not use ssh-agent if:
- You don't set a passphrase on your SSH keys
## Usage
@ -18,6 +18,6 @@ make package=ssh-agent
systemctl --user enable --now ssh-agent.service
```
In order for ssh-agent to cache your keys, you must first add them with `ssh-add`.
In order for ssh-agent to cache your keys, you must first add them with `ssh-add` or use `AddKeysToAgent Yes` in your `~/.ssh/config`
[openssh]: https://www.archlinux.org/packages/core/x86_64/openssh/
[ssh]: https://www.archlinux.org/packages/core/x86_64/openssh/

40
vim/README.md
View File

@ -1,32 +1,34 @@
# Vim
I use neovim as my main text editor, and vim elsewhere.
[vim][vim] is the standard text editor.
## Use Cases
vim can be used to:
- Edit source files efficiently
You should not use vim if:
- You should use vim.
## Dependencies
- [vim][vim] - If you're reading this, you probably already know what vim is
- [neovim][neovim] - An improved version of vim (cursor modes, sane defaults, etc.)
- [python-pywal][python-pywal] - Changing color schemes support
- [pywal][pywal] - Changing color schemes support
- [fzf][fzf] - Fuzzy search support
- [ripgrep][ripgrep] - Jump between lines in files
- [git][git] - Git diff support
- Any other features you want to use (e.g. TeX support with [texlive-core][texlive-core])
## Installation
```sh
make package=vim
```
- [texlive][texlive]) - TeX support
## Usage
I use [vim-plug][vim-plug] as my plugin manager of choice. If it isn't installed already, my `.vimrc` will install it for you. If you already have vim-plug installed, run `:PlugInstall`. Now you can use my vim config with all the plugins enabled!
The first time you start vim, my plugins will be automatically installed with [vim-plug][vim-plug] (unless you already have the wal plugin, in which case you'd need to run `:PlugInstall` manually).
[vim-plug]: https://github.com/junegunn/vim-plug
[vim]: https://www.archlinux.org/packages/extra/x86_64/vim/
[neovim]: https://www.archlinux.org/packages/community/x86_64/neovim/
[python-pywal]: https://www.archlinux.org/packages/community/any/python-pywal/
[fzf]: https://www.archlinux.org/packages/community/x86_64/fzf/
[ripgrep]: https://www.archlinux.org/packages/community/x86_64/ripgrep/
[git]: https://www.archlinux.org/packages/extra/x86_64/git/
[texlive-core]: https://www.archlinux.org/packages/extra/any/texlive-core/
[vim]: https://github.com/vim/vim
[neovim]: https://github.com/neovim/neovim
[pywal]: https://github.com/dylanaraps/pywal
[fzf]: https://github.com/junegunn/fzf
[ripgrep]: https://github.com/BurntSushi/ripgrep
[git]: https://github.com/git/git
[texlive]: https://github.com/TeX-Live/texlive-source

31
xmodmap/README.md
View File

@ -1,30 +1,23 @@
# xmodmap
I use xmodmap with xcape to make Caps Lock function as Escape when pressed and Ctrl when held down.
[xmodmap][xmodmap] is used to change the functionality of keys on your keyboard.
## Dependencies
## Use Cases
- `xorg-xmodmap` - Used to make caps lock work as ctrl
- `xcape` - Used to make caps lock work as escape
xmodmap can be used to:
## Installation
- Make Caps Lock function as Ctrl when held down
- Used with [xcape][xcape] to make Caps Lock function as Escape when pressed
```sh
make package=xmodmap
```
You should not use xmodmap if:
- You do not need to modify keys
## Usage
Start `xmodmap` in one of your init scripts, like so:
Run `xmodmap ~/.xmodmap` in one of your init scripts to make Caps Lock function as Ctrl when held down.
```sh
# Make caps lock work as ctrl
xmodmap ~/.xmodmap
```
Then, use `xcape -e 'Control_L=Escape'` to make Caps Lock (left Ctrl) function as Escape when pressed.
To make caps lock work as Escape, start xcape as well:
```sh
# Make caps lock (left ctrl) work as escape
xcape -e 'Control_L=Escape'
```
[xmodmap]: https://wiki.archlinux.org/index.php/Xmodmap
[xcape]: https://github.com/alols/xcape