From 0cc08acd8e93dcbe88bbb48160052e2ca4af5281 Mon Sep 17 00:00:00 2001
From: Oliver Blanthorn <freedom4cows@gmail.com>
Date: Sat, 5 May 2018 13:06:49 +0100
Subject: [PATCH] Improve guiset documentation

---
 CHANGELOG.md  |  7 +++++++
 src/excmds.ts | 27 ++++++++++++++++++++++++++-
 2 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b0c225b7..e6316ede 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Tridactyl changelog
 
+## Release 1.11.0 / Unreleased
+
+- You can now edit the Firefox GUI from Tridactyl with `guiset`. You must restart Firefox after using `guiset` to see the effects.
+    - e.g, `guiset gui none` or `guiset gui full`.
+    - see all the options with `help guiset` and following the links.
+    - **Only minimally tested. Back up your precious userChrome.css if you care about it!**
+
 ## Release 1.10.1 / 2018-05-04
 
 - Add tabcloseallto{right,left} bound to `gx0` and `gx$`
diff --git a/src/excmds.ts b/src/excmds.ts
index c7b22fbc..58b3b57c 100644
--- a/src/excmds.ts
+++ b/src/excmds.ts
@@ -178,7 +178,7 @@ export async function editor() {
 import * as css_util from "./css_util"
 
 /**
- * Change which parts of the Firefox user interface are shown.
+ * Change which parts of the Firefox user interface are shown. **NB: This feature is experimental and might break stuff.**
  *
  * Might mangle your userChrome. Requires native messenger, and you must restart Firefox each time to see any changes. <!-- (unless you enable addon debugging and refresh using the browser toolbox) -->
  *
@@ -186,6 +186,31 @@ import * as css_util from "./css_util"
  *
  * Example usage: `guiset gui none`, `guiset gui full`, `guiset tabs autohide`.
  *
+ * Some of the available options:
+ *
+ * - gui
+ *      - full
+ *      - none
+ *
+ * - tabs
+ *      - always
+ *      - autohide
+ *
+ * - navbar
+ *      - always
+ *      - autohide
+ *
+ * - hoverlink (the little link that appears when you hover over a link)
+ *      - none
+ *      - left
+ *      - right
+ *      - top-left
+ *      - top-right
+ *
+ * - titlebar
+ *      - hide
+ *      - show
+ *
  */
 //#background
 export async function guiset(rule: string, option: string) {