From 29c576de63a3de6da6a2f4909f151b3d5d157060 Mon Sep 17 00:00:00 2001
From: Rutger Broekhoff
Date: Tue, 30 Apr 2024 02:20:00 +0200
Subject: Improve man pages

Added an explanation on the type of key that is expected. Also tried to
fix layout of the path structure explanation in gitolfs3-server(1), so
that it also looks okay when rendered as a PDF. (On the PDF generated
using mandoc it still looks a bit weird, but I don't think I'll try to
solve that right now.)
---
 docs/man/gitolfs3-authenticate.1 | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'docs/man/gitolfs3-authenticate.1')

diff --git a/docs/man/gitolfs3-authenticate.1 b/docs/man/gitolfs3-authenticate.1
index 3a9951e..3f44312 100644
--- a/docs/man/gitolfs3-authenticate.1
+++ b/docs/man/gitolfs3-authenticate.1
@@ -31,3 +31,13 @@ Must end with a slash.
 .B Required.
 The path to the key which is used to authorize the request to the Gitolfs3
 server.
+The key must be 128-character hexadecimal string, i.e., a 64-byte number.
+Such a key can, for example, be generated using OpenSSL, with the following
+command:
+
+	openssl rand -hex 64
+
+Note that the Gitolfs3 server must be configured to use exactly the same key
+for
+.B gitolfs3-authenticate
+to function.
-- 
cgit v1.2.3