[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/hyperdrive 4bab0428ae 31/33: Docs: Put Concepts section be
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/hyperdrive 4bab0428ae 31/33: Docs: Put Concepts section before Customization section |
Date: |
Wed, 11 Oct 2023 22:00:46 -0400 (EDT) |
branch: elpa/hyperdrive
commit 4bab0428aeb4a6a69bca637758324593d0f19ffa
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>
Docs: Put Concepts section before Customization section
---
doc/hyperdrive-manual.org | 148 +++++++++++++++++++++++-----------------------
1 file changed, 74 insertions(+), 74 deletions(-)
diff --git a/doc/hyperdrive-manual.org b/doc/hyperdrive-manual.org
index de46da44dd..18d6136f70 100644
--- a/doc/hyperdrive-manual.org
+++ b/doc/hyperdrive-manual.org
@@ -508,80 +508,6 @@ or public key.
For examples, see [[*Mirror a whole directory]] and [[*Mirror files by tag or
other attributes]].
-* Customization
-
-You can customize the following variables settings by running ~M-x
-customize-group RET hyperdrive RET~:
-
-#+vindex: hyperdrive-storage-location
-- ~hyperdrive-storage-location~ :: Location to store Hypercore
- data. Defaults to ~"~/.local/share/hyper-gateway-nodejs/"~.
-
-#+vindex: hyperdrive-hyper-gateway-port
-- ~hyperdrive-hyper-gateway-port~ :: Port on which to run the
- hyper-gateway server. Defaults to ~4973~.
-
-#+vindex: hyperdrive-honor-auto-mode-alist
-- ~hyperdrive-honor-auto-mode-alist~ :: If non-nil, use file extension
- of hyperdrive file to set ~major-mode~. Defaults to ~t~.
-
-#+vindex: hyperdrive-persist-location
-- ~hyperdrive-persist-location~ :: Location where ~persist~ will store
- data, currently ~hyperdrive-hyperdrives~ and ~hyperdrive-version-ranges~.
- By default, uses the default ~persist~ location.
-
-#+vindex: hyperdrive-download-directory
-- ~hyperdrive-download-directory~ :: Location where
- ~hyperdrive-download-url~ will download files. Defaults to
- ~eww-download-directory~ or, if not bound, the home directory.
-
-#+vindex: hyperdrive-timestamp-format
-- ~hyperdrive-timestamp-format~ :: Format string used for
- timestamps. Passed to ~format-time-string~, which see.
-
-#+vindex: hyperdrive-directory-display-buffer-action
-- ~hyperdrive-directory-display-buffer-action~ :: Display buffer action
- for hyperdrive directories. Passed to ~display-buffer~, which see.
-
-#+vindex: hyperdrive-directory-sort
-- ~hyperdrive-directory-sort~ :: Column by which directory entries are sorted.
-Internally, a cons cell of (COLUMN . DIRECTION), the COLUMn being one
-of the directory listing columns (~name~, ~size~, or ~mtime~) and
-DIRECTION being one of ~:ascending~ or ~:descending~.
-
-#+vindex: hyperdrive-history-display-buffer-action
-- ~hyperdrive-history-display-buffer-action~ :: Display buffer action
- for hyperdrive history buffers. Passed to ~display-buffer~, which see.
-
-#+vindex: hyperdrive-default-host-format
-- ~hyperdrive-default-host-format~ :: Default format for displaying
- hyperdrive hostnames. See [[*Naming][Naming]] section for what this means.
-
-#+vindex: hyperdrive-stream-player-command
-- ~hyperdrive-stream-player-command~ :: Command used to play streamable
- URLs externally. Default uses [[https://mpv.io/][mpv]]. There also exists a
preconfigured
- option for [[https://www.videolan.org/vlc/][VLC media player]].
-
-#+vindex: hyperdrive-queue-limit
-- ~hyperdrive-queue-limit~ :: Default number of request sent to
- ~hyper-gateway~ at a time in a queues. Defaults to ~20~.
-
-#+vindex: hyperdrive-fill-version-ranges-limit
-- ~hyperdrive-queue-limit~ :: Default maximum number of requests when
- filling version history. Defaults to ~10~.
-
-#+vindex: hyperdrive-render-html
-- ~hyperdrive-render-html~ :: Control how HTML hyperdrive files are
- displayed. By default, HTML pages are rendered in Emacs with
[[info:eww#Top][EWW]]. If
- ~nil~, raw HTML will be displayed.
-
-#+vindex: hyperdrive-reuse-buffers
-- ~hyperdrive-reuse-buffers~ :: How to reuse buffers when showing entries.
- By default (~any-version~), opening a hyperdrive file or directory
- reuses a buffer that is already visiting it, regardless of
- version. To have separate buffers for each version of a
- file/directory, use ~same-version~.
-
* Concepts
** Hyperdrive
@@ -829,6 +755,80 @@ connections.
DNS domains are checked for suspicious characters (see
[[info:elisp#Suspicious Text]]).
+* Customization
+
+You can customize the following variables settings by running ~M-x
+customize-group RET hyperdrive RET~:
+
+#+vindex: hyperdrive-storage-location
+- ~hyperdrive-storage-location~ :: Location to store Hypercore
+ data. Defaults to ~"~/.local/share/hyper-gateway-nodejs/"~.
+
+#+vindex: hyperdrive-hyper-gateway-port
+- ~hyperdrive-hyper-gateway-port~ :: Port on which to run the
+ hyper-gateway server. Defaults to ~4973~.
+
+#+vindex: hyperdrive-honor-auto-mode-alist
+- ~hyperdrive-honor-auto-mode-alist~ :: If non-nil, use file extension
+ of hyperdrive file to set ~major-mode~. Defaults to ~t~.
+
+#+vindex: hyperdrive-persist-location
+- ~hyperdrive-persist-location~ :: Location where ~persist~ will store
+ data, currently ~hyperdrive-hyperdrives~ and ~hyperdrive-version-ranges~.
+ By default, uses the default ~persist~ location.
+
+#+vindex: hyperdrive-download-directory
+- ~hyperdrive-download-directory~ :: Location where
+ ~hyperdrive-download-url~ will download files. Defaults to
+ ~eww-download-directory~ or, if not bound, the home directory.
+
+#+vindex: hyperdrive-timestamp-format
+- ~hyperdrive-timestamp-format~ :: Format string used for
+ timestamps. Passed to ~format-time-string~, which see.
+
+#+vindex: hyperdrive-directory-display-buffer-action
+- ~hyperdrive-directory-display-buffer-action~ :: Display buffer action
+ for hyperdrive directories. Passed to ~display-buffer~, which see.
+
+#+vindex: hyperdrive-directory-sort
+- ~hyperdrive-directory-sort~ :: Column by which directory entries are sorted.
+Internally, a cons cell of (COLUMN . DIRECTION), the COLUMn being one
+of the directory listing columns (~name~, ~size~, or ~mtime~) and
+DIRECTION being one of ~:ascending~ or ~:descending~.
+
+#+vindex: hyperdrive-history-display-buffer-action
+- ~hyperdrive-history-display-buffer-action~ :: Display buffer action
+ for hyperdrive history buffers. Passed to ~display-buffer~, which see.
+
+#+vindex: hyperdrive-default-host-format
+- ~hyperdrive-default-host-format~ :: Default format for displaying
+ hyperdrive hostnames. See [[*Naming][Naming]] section for what this means.
+
+#+vindex: hyperdrive-stream-player-command
+- ~hyperdrive-stream-player-command~ :: Command used to play streamable
+ URLs externally. Default uses [[https://mpv.io/][mpv]]. There also exists a
preconfigured
+ option for [[https://www.videolan.org/vlc/][VLC media player]].
+
+#+vindex: hyperdrive-queue-limit
+- ~hyperdrive-queue-limit~ :: Default number of request sent to
+ ~hyper-gateway~ at a time in a queues. Defaults to ~20~.
+
+#+vindex: hyperdrive-fill-version-ranges-limit
+- ~hyperdrive-queue-limit~ :: Default maximum number of requests when
+ filling version history. Defaults to ~10~.
+
+#+vindex: hyperdrive-render-html
+- ~hyperdrive-render-html~ :: Control how HTML hyperdrive files are
+ displayed. By default, HTML pages are rendered in Emacs with
[[info:eww#Top][EWW]]. If
+ ~nil~, raw HTML will be displayed.
+
+#+vindex: hyperdrive-reuse-buffers
+- ~hyperdrive-reuse-buffers~ :: How to reuse buffers when showing entries.
+ By default (~any-version~), opening a hyperdrive file or directory
+ reuses a buffer that is already visiting it, regardless of
+ version. To have separate buffers for each version of a
+ file/directory, use ~same-version~.
+
* Known limitations
** No empty directories
- [nongnu] elpa/hyperdrive a416692858 01/33: Change: (hyperdrive-menu) "Hyperdrives" -> "Hyperdrive", (continued)
- [nongnu] elpa/hyperdrive a416692858 01/33: Change: (hyperdrive-menu) "Hyperdrives" -> "Hyperdrive", ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 5100391bdd 05/33: Change: (hyperdrive--easy-menu-contents) Add "Bookmark" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive a971395216 09/33: Change: (--easy-menu-contents) Add "Customize" and "Info Manual", ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive c47455dbe7 21/33: Add workaround for Emacs bug, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive dc59d7f775 23/33: Change: (-global-easy-menu) Move find/view file into "Drives", ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 77301eeddb 25/33: Change: (-global-easy-menu) Move "Describe" to top of submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 029f2b12aa 27/33: Comment: Remove TODO, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 1001388732 15/33: Change: (hyperdrive--easy-menu-contents) Use :active in "Bookmark", ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive bfa91f271b 04/33: Change: (hyperdrive--easy-menu-contents) Add "Gateway" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 071d34ef8b 17/33: Change: (hyperdrive--easy-menu-contents) Add "Selected" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 4bab0428ae 31/33: Docs: Put Concepts section before Customization section,
ELPA Syncer <=
- [nongnu] elpa/hyperdrive ee8f4ade22 30/33: Merge: Add easy-menu menu bar, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive e827f6406c 12/33: Change: (hyperdrive--easy-menu-contents) Add "Files" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive ac9b8f901f 14/33: Change: (--easy-menu-contents) Add "Current File/Directory" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive a21360fda7 24/33: Change: (-global-easy-menu) Open URL into top level, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 91e40facbd 26/33: Change: (-global-easy-menu) Sort "Drives" submenu, ELPA Syncer, 2023/10/11
- [nongnu] elpa/hyperdrive 3d8a56619b 32/33: Fix: (hyperdrive-global-easy-menu) Call hyperdrive-purge in "Purge", ELPA Syncer, 2023/10/11