From 6ef9d4873e2fa11fe845e8641653eda3ce82ffa5 Mon Sep 17 00:00:00 2001
From: sternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>
Date: Wed, 17 Feb 2021 18:49:33 +0100
Subject: pkgs/profpatsch/nman(1): add DISCLAIMER section

We want to discourage scripting with nman, as we may want to tweak the
user interface or internal behavior of nman in the future without
maintaining backwards compatibilty.

In other words: You have been warned.
---
 pkgs/profpatsch/nman/nman.1 | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'pkgs/profpatsch')

diff --git a/pkgs/profpatsch/nman/nman.1 b/pkgs/profpatsch/nman/nman.1
index 57e7e0f3..c6255827 100644
--- a/pkgs/profpatsch/nman/nman.1
+++ b/pkgs/profpatsch/nman/nman.1
@@ -69,6 +69,19 @@ Uses the described method to find the man page
 from package
 .Ar ATTR .
 .El
+.Sh DISCLAIMER
+.Nm
+is intended to be used interactively:
+It automatically launches a pager and relies heavily on heuristics
+to automatically
+.Dq do the right thing
+without the user having to think about it.
+The nature of such heuristics however dictates that they are often
+imperfect and require tweaking.
+.Pp
+Therefore neither the behavior nor the user interface of
+.Nm
+should be considered stable or used for scripting purposes.
 .Sh IMPLEMENTATION NOTES
 .Nm
 uses
-- 
cgit 1.4.1