emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/hyperdrive 001ed377b9 08/16: Docs: Add "Name a hyperdrive"


From: ELPA Syncer
Subject: [nongnu] elpa/hyperdrive 001ed377b9 08/16: Docs: Add "Name a hyperdrive" section
Date: Sat, 2 Dec 2023 18:59:41 -0500 (EST)

branch: elpa/hyperdrive
commit 001ed377b9ea0e836daf913aaf84fe6cb0a5eb24
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>

    Docs: Add "Name a hyperdrive" section
---
 doc/hyperdrive.org  | 33 ++++++++++++++++++++++++---------
 doc/hyperdrive.texi | 36 +++++++++++++++++++++++++++---------
 2 files changed, 51 insertions(+), 18 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 74f2a0d8d0..40b8660a10 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -371,6 +371,9 @@ keys]]) that uniquely identifies that hyperdrive.
 
   Create a new hyperdrive from a seed string.
 
+When you create a new drive, your chosen seed is used as its petname
+(see [[*Petnames]]) by default.
+
 ** Write to a hyperdrive
 #+vindex: save-some-buffers-default-predicate
 
@@ -547,6 +550,26 @@ means, see [[*Naming]].
   file or directory.  To describe a different hyperdrive, use the
   universal prefix argument: ~C-u M-x hyperdrive-describe-hyperdrive~.
 
+** Name a hyperdrive
+
+~hyperdrive.el~ supports different ways to identify hyperdrives (see
+[[*Naming]]).  The following commands can be used to name hyperdrives:
+
+- Command: hyperdrive-set-petname ::
+
+  Set the petname (see [[*Petnames]]) of the hyperdrive for the current
+  hyperdrive file or directory.  You can't use the same petname for
+  multiple hyperdrives.  To set the petname of a different hyperdrive,
+  use the universal prefix argument: ~C-u M-x hyperdrive-set-petname~.
+
+- Command: hyperdrive-set-nickname ::
+
+  Set the nickname (see [[*Nicknames]]) of the hyperdrive for the current
+  hyperdrive file or directory.  You can only set the nickname for a
+  hyperdrive which you previously created.  To set the nickname of a
+  different hyperdrive, use the universal prefix argument like this:
+  ~C-u M-x hyperdrive-set-nickname~.
+
 ** Bookmark a hyperdrive
 #+findex: bookmark-set
 #+findex: bookmark-jump
@@ -954,7 +977,6 @@ Each drive may also have one or both of the following 
attributes:
 
 *** Public keys
 #+cindex: Public keys
-#+findex: hyperdrive-new
 
 Public keys are globally unique identifiers for hyperdrives.  They
 make up the first part of a ~hyper://~ URL.  Public keys are
@@ -965,7 +987,6 @@ public key.
 
 *** Nicknames
 #+cindex: Nicknames
-#+findex: hyperdrive-set-nickname
 
 Nicknames are public, memorable names which you can give to your own
 hyperdrives to make them easier for others to recognize.  Other users
@@ -973,20 +994,14 @@ can see your nicknames but cannot change them.
 
 Nicknames are stored in each hyperdrive inside
 ~/.well-known/host-meta.json~ under the ~name~ key, as specified in
-[[https://www.rfc-editor.org/rfc/rfc6415#section-6.1][RFC6415]].  You can 
update a hyperdrive's nickname with
-~hyperdrive-set-nickname~.
+[[https://www.rfc-editor.org/rfc/rfc6415#section-6.1][RFC6415]].
 
 *** Petnames
 #+cindex: Petnames
-#+findex: hyperdrive-set-petname
 
 Petnames are locally unique hyperdrive identifiers. You can give a
 petname to any hyperdrive you load, whether you created it or not.
 
-When creating a new drive, your chosen seed (see [[*Seeds]]) is used as its
-petname by default. Petnames can be changed with
-~hyperdrive-set-petname~, but drives cannot share a petname.
-
 *** Seeds
 #+cindex: Seeds
 
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 1b3741accb..209dd61b1a 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -90,6 +90,7 @@ Usage
 * Delete a hyperdrive file::
 * View the hyperdrive version history::
 * Describe a hyperdrive::
+* Name a hyperdrive::
 * Bookmark a hyperdrive::
 * Stream audio and video::
 * Download hyperdrive files::
@@ -351,6 +352,7 @@ On the network it still may be there.
 * Delete a hyperdrive file::
 * View the hyperdrive version history::
 * Describe a hyperdrive::
+* Name a hyperdrive::
 * Bookmark a hyperdrive::
 * Stream audio and video::
 * Download hyperdrive files::
@@ -620,6 +622,9 @@ master key (see @ref{Master key}) to produce a public key 
(see @ref{Public keys}
 Create a new hyperdrive from a seed string.
 @end deffn
 
+When you create a new drive, your chosen seed is used as its petname
+(see @ref{Petnames}) by default.
+
 @node Write to a hyperdrive
 @section Write to a hyperdrive
 
@@ -832,6 +837,27 @@ file or directory.  To describe a different hyperdrive, 
use the
 universal prefix argument: @code{C-u M-x hyperdrive-describe-hyperdrive}.
 @end deffn
 
+@node Name a hyperdrive
+@section Name a hyperdrive
+
+@code{hyperdrive.el} supports different ways to identify hyperdrives (see
+@ref{Naming}).  The following commands can be used to name hyperdrives:
+
+@deffn Command hyperdrive-set-petname
+Set the petname (see @ref{Petnames}) of the hyperdrive for the current
+hyperdrive file or directory.  You can't use the same petname for
+multiple hyperdrives.  To set the petname of a different hyperdrive,
+use the universal prefix argument: @code{C-u M-x hyperdrive-set-petname}.
+@end deffn
+
+@deffn Command hyperdrive-set-nickname
+Set the nickname (see @ref{Nicknames}) of the hyperdrive for the current
+hyperdrive file or directory.  You can only set the nickname for a
+hyperdrive which you previously created.  To set the nickname of a
+different hyperdrive, use the universal prefix argument like this:
+@code{C-u M-x hyperdrive-set-nickname}.
+@end deffn
+
 @node Bookmark a hyperdrive
 @section Bookmark a hyperdrive
 
@@ -1350,7 +1376,6 @@ public, globally unique, human-memorable
 @subsection Public keys
 
 @cindex Public keys
-@findex hyperdrive-new
 
 Public keys are globally unique identifiers for hyperdrives.  They
 make up the first part of a @code{hyper://} URL@.  Public keys are
@@ -1363,7 +1388,6 @@ public key.
 @subsection Nicknames
 
 @cindex Nicknames
-@findex hyperdrive-set-nickname
 
 Nicknames are public, memorable names which you can give to your own
 hyperdrives to make them easier for others to recognize.  Other users
@@ -1371,22 +1395,16 @@ can see your nicknames but cannot change them.
 
 Nicknames are stored in each hyperdrive inside
 @code{/.well-known/host-meta.json} under the @code{name} key, as specified in
-@uref{https://www.rfc-editor.org/rfc/rfc6415#section-6.1, RFC6415}.  You can 
update a hyperdrive's nickname with
-@code{hyperdrive-set-nickname}.
+@uref{https://www.rfc-editor.org/rfc/rfc6415#section-6.1, RFC6415}.
 
 @node Petnames
 @subsection Petnames
 
 @cindex Petnames
-@findex hyperdrive-set-petname
 
 Petnames are locally unique hyperdrive identifiers. You can give a
 petname to any hyperdrive you load, whether you created it or not.
 
-When creating a new drive, your chosen seed (see @ref{Seeds}) is used as its
-petname by default. Petnames can be changed with
-@code{hyperdrive-set-petname}, but drives cannot share a petname.
-
 @node Seeds
 @subsection Seeds
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]