aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2020-10-14 20:48:46 +0300
committerAqua-sama <aqua@iserlohn-fortress.net>2020-10-14 20:48:46 +0300
commit23f44a53708ee460b25e070de28c7c42165b3087 (patch)
treed120647e709cbba1dbc133b6fd5e81a2ddf96e24 /man
parentUse crates.io/rustyline as readline (diff)
downloadrshell-23f44a53708ee460b25e070de28c7c42165b3087.tar.xz
Check arguments passed to cd
Diffstat (limited to 'man')
-rw-r--r--man/rs.1.scd25
-rw-r--r--man/rs.5.scd24
2 files changed, 49 insertions, 0 deletions
diff --git a/man/rs.1.scd b/man/rs.1.scd
new file mode 100644
index 0000000..f6ac4ef
--- /dev/null
+++ b/man/rs.1.scd
@@ -0,0 +1,25 @@
+rs(1)
+
+# NAME
+
+rs - yet another shell
+
+# DESCRIPTION
+
+This is yet another shell
+
+# BUILTINS
+
+## cd(new_dir)
+change directory to new_dir
+
+## exit
+quit the shell
+TODO: check background jobs
+
+# SEE ALSO
+rs(5) for configuration options
+
+# AUTHORS
+Maintained by Aqua <aqua@iserlohn-fortress.net>. The source code can be found
+at https://neueland.iserlohn-fortress.net/cgit/rshell/.
diff --git a/man/rs.5.scd b/man/rs.5.scd
new file mode 100644
index 0000000..952c350
--- /dev/null
+++ b/man/rs.5.scd
@@ -0,0 +1,24 @@
+rs(5) "rs configuration"
+
+# NAME
+
+rs - yet another shell
+
+# DESCRIPTION
+
+This is yet another shell
+
+# MOTD
+The motd printed on startup is read from /etc/motd.
+TODO: disable toggle
+
+# PROMPT
+To set the prompt, use the PROMPT environment variable. If one is not set,
+ " {USER}@{HOST} [{PWD}]\n{$} "
+is used by default.
+
+- {USER} is replaced by username
+- {HOST} is replaced by hostname
+- {$} is replaced by '#' for root and '$' for other users
+- {PWD} is replaced by current directory path
+