Browse Source

docs: add info on man page installation (#6894)

remyabel2 2 years ago
parent
commit
c56025000b
1 changed files with 13 additions and 0 deletions
  1. 13 0
      docs/installation.rst

+ 13 - 0
docs/installation.rst

@@ -358,6 +358,19 @@ activating your virtual environment::
 
     pip install -U borgbackup  # or ... borgbackup[llfuse/pyfuse3]
 
+When doing manual pip installation, man pages are not automatically
+installed.  You can run these commands to install the man pages
+locally::
+
+    # get borg from github
+    git clone https://github.com/borgbackup/borg.git borg
+
+    # Install the files with proper permissions
+    install -D -m 0644 borg/docs/man/borg*.1* $HOME/.local/share/man/man1/borg.1
+
+    # Update the man page cache
+    mandb
+
 .. _git-installation:
 
 Using git