aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-06-25 19:13:13 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-06-25 19:13:13 +0200
commitc7270b9b0f0dbd44a6089e54665182c381f36015 (patch)
treeaa0c24def68f7848fd4abf8c2ae8d75f084ba861 /doc
parentAdd ProfileManager (diff)
downloadsmolbote-c7270b9b0f0dbd44a6089e54665182c381f36015.tar.xz
Update pkgbuild
Diffstat (limited to 'doc')
-rw-r--r--doc/ManPage.md15
-rw-r--r--doc/Profile.md17
-rw-r--r--doc/RepositoryCommands.md8
3 files changed, 40 insertions, 0 deletions
diff --git a/doc/ManPage.md b/doc/ManPage.md
new file mode 100644
index 0000000..d3f7c74
--- /dev/null
+++ b/doc/ManPage.md
@@ -0,0 +1,15 @@
+The manpage format is ridiculous, so they get generated from markdown (which is more sane in comparison)
+
+### with ronn
+~~~sh
+## install
+gem install --user-install ronn
+## generate
+ronn smolbote.7.ronn
+~~~
+
+### with go-md2man
+~~~sh
+go-md2man -in smolbote.md -out smolbote.7
+~~~
+
diff --git a/doc/Profile.md b/doc/Profile.md
new file mode 100644
index 0000000..d205a86
--- /dev/null
+++ b/doc/Profile.md
@@ -0,0 +1,17 @@
+Profiles are read from profile.path
+
+## Settings
+
+- otr (defaults to true) - is this profile off-the-record
+- name (defaults to the configuration file name)
+- search (defaults to profile.search) - search engine url
+- homepage (defaults to profile.homepage)
+- newtab (defaults to profile.newtab)
+
+### Properties
+Key is property name; value is property value
+
+### Attributes
+see QWebEngineSetting::WebAttribute for list of IDs.
+Key is attribute id; value is attribute value (true/false)
+
diff --git a/doc/RepositoryCommands.md b/doc/RepositoryCommands.md
new file mode 100644
index 0000000..6255214
--- /dev/null
+++ b/doc/RepositoryCommands.md
@@ -0,0 +1,8 @@
+## Official documentation
+From https://www.mercurial-scm.org/wiki/HttpCommandProtocol
+
+## branchmap
+$ curl "https://neueland.iserlohn-fortress.net/smolbote.hg/?cmd=branchmap"
+default 197043ea8aac871126694366203ffabd7ae03935
+<branchname> <node>
+