diff options
| -rw-r--r-- | doc/api.md | 10 | ||||
| -rw-r--r-- | doc/config.md | 14 |
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/api.md b/doc/api.md index 0480e901..004b52af 100644 --- a/doc/api.md +++ b/doc/api.md @@ -120,6 +120,16 @@ Use this for loading automatically retrieved (i.e. non-user-provided) URLs.</td> </tr> <tr> +<td>`nextBuffer()`, `prevBuffer()`, `nextSiblingBufer()`, `prevSiblingBuffer()`, +`parentBuffer()`</td> +<td>Traverse the buffer tree.<br> +`nextBuffer()`, `prevBuffer()` do a depth-first traversal; +``nextSiblingBufer()`, `prevSiblingBuffer()` cycle through siblings, and +`parentBuffer()` returns to the parent. +</td> +</tr> + +<tr> <td>`dupeBuffer()`</td> <td>Duplicate the current buffer by loading its source to a new buffer.</td> </tr> diff --git a/doc/config.md b/doc/config.md index 3ccb70f4..91894911 100644 --- a/doc/config.md +++ b/doc/config.md @@ -1024,6 +1024,20 @@ company or their product in any way.)</td> </tr> <tr> +<td>`cmd.pager.nextBuffer`, `cmd.pager.prevBuffer`, +`cmd.pager.prevSiblingBuffer`, `cmd.pager.nextSiblingBufer`, +`cmd.pager.parentBuffer`</td> +<td>Traverse the buffer tree.<br> +`nextBuffer` and `prevBuffer` are the most intuitive, traversing the tree as if +it were a linked list.<br> +`prevSiblingBuffer` and `nextSiblingBuffer` cycle through the buffers opened +from the same buffer.<br> +Finally, `parentBuffer` always returns to the buffer the current buffer was +opened from, even if e.g. the user returns and opens another page "in between". +</td> +</tr> + +<tr> <td>`cmd.pager.dupeBuffer`</td> <td>Duplicate the current buffer by loading its source to a new buffer.</td> </tr> |