Merge pull request #537 from lightninglabs/docs-lnd

Update lnd documentation
lightninglabs · Jul 18, 2023 · 756dcf3 · 756dcf3
2 parents 4c6d230 + c8988c8
commit 756dcf3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/docs/lnd/INSTALL.md b/docs/lnd/INSTALL.md
@@ -316,11 +316,11 @@ The set of arguments for each of the backend modes is as follows:
 ## btcd Options
 ```text
 btcd:
-      --btcd.dir=                                             The base directory that contains the node's data, logs, configuration file, etc. (default: /Users/roasbeef/Library/Application Support/Btcd)
+      --btcd.dir=                                             The base directory that contains the node's data, logs, configuration file, etc. (default: /Users/<username>/Library/Application Support/Btcd)
       --btcd.rpchost=                                         The daemon's rpc listening address. If a port is omitted, then the default port for the selected chain parameters will be used. (default: localhost)
       --btcd.rpcuser=                                         Username for RPC connections
       --btcd.rpcpass=                                         Password for RPC connections
-      --btcd.rpccert=                                         File containing the daemon's certificate file (default: /Users/roasbeef/Library/Application Support/Btcd/rpc.cert)
+      --btcd.rpccert=                                         File containing the daemon's certificate file (default: /Users/<username>/Library/Application Support/Btcd/rpc.cert)
       --btcd.rawrpccert=                                      The raw bytes of the daemon's PEM-encoded certificate chain which will be used to authenticate the RPC connection.
 ```
 
@@ -339,7 +339,7 @@ neutrino:
 ## Bitcoind Options
 ```text
 bitcoind:
-      --bitcoind.dir=                                         The base directory that contains the node's data, logs, configuration file, etc. (default: /Users/roasbeef/Library/Application Support/Bitcoin)
+      --bitcoind.dir=                                         The base directory that contains the node's data, logs, configuration file, etc. (default: /Users/<username>/Library/Application Support/Bitcoin)
       --bitcoind.rpchost=                                     The daemon's rpc listening address. If a port is omitted, then the default port for the selected chain parameters will be used. (default: localhost)
       --bitcoind.rpcuser=                                     Username for RPC connections
       --bitcoind.rpcpass=                                     Password for RPC connections
@@ -596,7 +596,7 @@ launches, allowing you to simply type `lnd --bitcoin.testnet --bitcoin.active`
 at the command line, you can create an `lnd.conf`.
 
 **On MacOS, located at:**
-`/Users/[username]/Library/Application Support/Lnd/lnd.conf`
+`/Users/<username>/Library/Application Support/Lnd/lnd.conf`
 
 **On Linux, located at:**
 `~/.lnd/lnd.conf`

diff --git a/docs/lnd/grpc/java.md b/docs/lnd/grpc/java.md
@@ -149,8 +149,8 @@ public class Main {
     }
   }
 
-  private static final String CERT_PATH = "/Users/user/Library/Application Support/Lnd/tls.cert";
-  private static final String MACAROON_PATH = "/Users/user/Library/Application Support/Lnd/data/chain/bitcoin/simnet/admin.macaroon";
+  private static final String CERT_PATH = "/Users/<username>/Library/Application Support/Lnd/tls.cert";
+  private static final String MACAROON_PATH = "/Users/<username>/Library/Application Support/Lnd/data/chain/bitcoin/simnet/admin.macaroon";
   private static final String HOST = "localhost";
   private static final int PORT = 10009;
 
@@ -197,10 +197,10 @@ $  mvn compile exec:java -Dexec.mainClass="Main" -Dexec.cleanupDaemonThreads=fal
 [INFO] ------------------------------------------------------------------------
 [INFO]
 [INFO] --- protobuf-maven-plugin:0.6.1:compile (default) @ lightning-client ---
-[INFO] Compiling 3 proto file(s) to /Users/user/Documents/Projects/lightningclient/target/generated-sources/protobuf/java
+[INFO] Compiling 3 proto file(s) to /Users/<username>/Documents/Projects/lightningclient/target/generated-sources/protobuf/java
 [INFO]
 [INFO] --- protobuf-maven-plugin:0.6.1:compile-custom (default) @ lightning-client ---
-[INFO] Compiling 3 proto file(s) to /Users/user/Documents/Projects/lightningclient/target/generated-sources/protobuf/grpc-java
+[INFO] Compiling 3 proto file(s) to /Users/<username>/Documents/Projects/lightningclient/target/generated-sources/protobuf/grpc-java
 [INFO]
 [INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ lightning-client ---
 [INFO] Using 'UTF-8' encoding to copy filtered resources.
@@ -210,7 +210,7 @@ $  mvn compile exec:java -Dexec.mainClass="Main" -Dexec.cleanupDaemonThreads=fal
 [INFO]
 [INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ lightning-client ---
 [INFO] Changes detected - recompiling the module!
-[INFO] Compiling 12 source files to /Users/user/Documents/Projects/lightningclient/target/classes
+[INFO] Compiling 12 source files to /Users/<username>/Documents/Projects/lightningclient/target/classes
 [INFO]
 [INFO] --- exec-maven-plugin:1.6.0:java (default-cli) @ lightning-client ---
 032562215c38dede6f1f2f262ff4c8db58a38ecf889e8e907eee8e4c320e0b5e81