summaryrefslogtreecommitdiff
path: root/doc/miscellaneous_features.md
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-04-12 18:10:53 -0700
committerBozhidar Batsov <bozhidar@batsov.com>2016-04-12 18:11:08 -0700
commit7a1c6862a6b58e8166ad75ff04d203fadf1ac21e (patch)
tree8deff5e0633af3e3390f37bbdfde310c3cf3cc03 /doc/miscellaneous_features.md
parentf3e837695a3dc319740d800c4c1e71272d14cee6 (diff)
Document a bunch of features
Diffstat (limited to 'doc/miscellaneous_features.md')
-rw-r--r--doc/miscellaneous_features.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/miscellaneous_features.md b/doc/miscellaneous_features.md
index 7f404167..240e0a44 100644
--- a/doc/miscellaneous_features.md
+++ b/doc/miscellaneous_features.md
@@ -141,6 +141,48 @@ and
(setq cider-refresh-show-log-buffer t)
```
+### Tracing function execution
+
+You can trace the results produced by functions using <kbd>C-c M-t v</kbd>. The
+command will prompt you for the name of the function you want to trace.
+Evaluating the command again for the same function will result in the function
+being untraced.
+
+![Tracing](images/tracing.png)
+
+You can also use <kbd>C-c M-t n</kbd> to toggle tracing on and off for an entire
+namespace.
+
+### Classpath browser
+
+You can easily browse the items on your classpath with the command `cider-classpath`.
+
+Here you can see it in action:
+
+![Classpath Browser](images/classpath_browser.png)
+
+Press <kbd>RET</kbd> on a classpath entry to navigate into it.
+
+### Namespace browser
+
+You can browse the contents of any loaded namespace with the command `cider-browse-ns`.
+The command will prompt you for the namespace to browse.
+
+![Namespace Browser](images/ns_browser.png)
+
+You can also browse all available namespaces with `cider-browse-ns-all`.
+
+There are a bunch of useful keybindings that are defined in browser buffers.
+
+Keyboard shortcut | Description
+--------------------------------|-------------------------------
+<kbd>d</kbd> | Display documentation for item at point.
+<kbd>RET</kbd> | Browse ns or display documentation for item at point.
+<kbd>s</kbd> | Go to definition for item at point.
+<kbd>^</kbd> | Browse all namespaces.
+<kbd>n</kbd> | Go to next line.
+<kbd>p</kbd> | Go to previos line.
+
### Managing multiple connections
You can connect to multiple nREPL servers using <kbd>M-x cider-jack-in</kbd> (or