add doc for k

This commit is contained in:
Aaron Bieber 2021-03-11 16:29:03 +00:00
parent 05b501dbad
commit 15c39c7efe
3 changed files with 79 additions and 3 deletions

View File

@ -0,0 +1,31 @@
body {
font-family: Roboto, arial, sans-serif;
}
#content {
width: 100%;
height: 100%;
}
.title {
}
#table-of-contents {
float: left;
width: 25%;
}
#table-of-contents h2 {
font-size: 20px;
}
.outline-2 {
float: right;
width: 75%;
}
#postamble {
float: left;
width: 100%;
}

View File

@ -4,11 +4,12 @@ Have your cake and eat it too!
~ohmyksh~ is a framework for expanding OpenBSD's [[https://man.openbsd.org/ksh][ksh]]. It offers:
- completions :: for common things like [[https://man.openbsd.org/man][man]] pages, [[https://man.openbsd.org/ssh][ssh]] known_hosts and git (and
got!) commands.
- completions :: for common things like [[https://man.openbsd.org/man][man]] pages, [[https://man.openbsd.org/ssh][ssh]] ~known_hosts~ and ~git~ (and
~got~!) commands.
- extensions :: to import bulk functionality, including git-prompt, OpenBSD
specific tooling, disabling color.. etc.
- prompts :: a decent selection of useful prompts.
- prompts :: a decent selection of useful, minimal prompts.
** Completions

View File

@ -0,0 +1,44 @@
#+TITLE: Extension: k
~k~ is a function that allows one to quickly jump to directories based off
simple pattern matching.
** Usage
*** Jumping to known locations
#+begin_src shell
qbit@tal[0]:~$ k ohmy
qbit@tal[0]:~/src/ohmyksh got:(master)$
#+end_src
*** Storing locations for later jumping
#+begin_src shell
cd ~/directory/with/long/name
k
#+end_src
After running ~k~, the current directory will be stored in ~~/.k~.
From this point on, you can reach the directory from anywhere by running ~k
long name~.
*** Removing locations from jump list
#+begin_src shell
k long name
k rm
#+end_src
*** Listing jumpable directories
#+begin_src shell
k ls
#+end_src
*** Sorting / removing duplicates
#+begin_src shell
k clean
#+end_src