summaryrefslogtreecommitdiff
path: root/docs/user-extra-documentation.md
diff options
context:
space:
mode:
authorAlex Leferry 2 <alexherbo2@gmail.com>2020-09-01 13:54:57 +0200
committerAlex Leferry 2 <alexherbo2@gmail.com>2020-09-01 14:07:05 +0200
commit04810ac05ec6751e76cf6ad31d97ada30857feb5 (patch)
treeeee1f31398a2509a6f99d3755517fccb1a130611 /docs/user-extra-documentation.md
parent4d4fc65db3cfdae71b26d32f09009414fb8337b2 (diff)
Update documentation
Diffstat (limited to 'docs/user-extra-documentation.md')
-rw-r--r--docs/user-extra-documentation.md77
1 files changed, 0 insertions, 77 deletions
diff --git a/docs/user-extra-documentation.md b/docs/user-extra-documentation.md
deleted file mode 100644
index 9348726..0000000
--- a/docs/user-extra-documentation.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# Extra documentation for users
-
-## FAQ
-
-### What’s the difference between `>` and `$`?
-
-`>` or `connect-terminal` runs its argument
-(which by default is your shell)
-inside a terminal,
-while `$` or `connect-shell` simply runs its argument.
-
-Some programs must be run inside a terminal,
-while others spawn their own graphical window.
-Use `>` for the first type and `$` for the second.
-
-### What’s the purpose of `&` or `connect-detach`?
-
-`connect-detach` detaches (closes) the current client
-(leaving you in a terminal if you launched Kakoune there) and
-creates a file named `connect.sh` which you can run with `sh connect.sh`
-to start a shell connected to that client’s server.
-The file is automatically erased when it’s sourced.
-
-**Note 1**: The Kakoune server is deleted if you detach the last client and
-you didn’t start it in daemon mode.
-
-**Note 2**: The implementation uses Kakoune’s `quit!` command instead of `quit`.
-
-### What is `kak-shell`?
-
-`kak-shell` is inspired by [nix-shell].
-
-It lets you run a program (by default your shell) connected to a session.
-Initially, it displays the list of active sessions and asks you to choose one.
-
-```
-$ kak-shell
-Kakoune sessions:
-1 kanto
-2 johto
-+ create new session
-Kakoune session: 1█
-@kanto $ :a█
-```
-
-If you enter a number _i_, it will try to connect to the _i_-th entry.
-Otherwise, it will interpret the entry as a session name and connect to it.
-If the session is not running, it will start it in daemon mode.
-
-Apart from running a connected shell, you can use `kak-shell` to run
-commands in the context of the session.
-For example, you could run `kak-shell tig` to run [tig] connected to an arbitrary session.
-
-[tig]: https://github.com/jonas/tig
-[nix-shell]: https://nixos.org/nix/manual#sec-nix-shell
-
----
-
-## Conventions and design decisions
-
-### What’s the difference between [commands] and [modules]?
-
-The term module is used for small program integrations for Kakoune
-(which are implemented as Kakoune’s modules).
-The term command is used for small binaries that can be used by a connected application.
-
-[commands]: ../rc/connect/commands
-[modules]: ../rc/modules
-
-### Why do all [commands] start with a colon (`:`)?
-
-The colon is the key used to access the prompt menu inside Kakoune.
-Because the commands usually resemble Kakoune commands,
-prepending them with a colon is a good way to reuse our muscle memory,
-and it makes it very simple to differentiate them from traditional commands
-(think of `pwd` versus `:pwd`).
-