man/passwd.5.xml: CAVEATS: Add section

Document that when reading passwd(5), the C locale should be used.

Cc: Iker Pedrosa <ipedrosa@redhat.com>
Cc: Mantas Mikulėnas <grawity@gmail.com>
Cc: KhaelK-Praetorian <khael.kugler@praetorian.com>
Cc: Tobias Stoeckmann <tobias@stoeckmann.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

diff --git a/man/passwd.5.xml b/man/passwd.5.xml
index c528e6977e8657ba301904d42e126f0f8d654c94..37b13622237306dcc73099838fc1ea174c0fadce 100644 (file)
--- a/man/passwd.5.xml
+++ b/man/passwd.5.xml
@@ -163,6 +163,20 @@
     </variablelist>
   </refsect1>
 
+  <refsect1 id='caveats'>
+    <title>CAVEATS</title>
+    <para>
+      Unprivileged users may write
+      arbitrary non-ASCII characters
+      in the GECOS field,
+      notably including C1 control characters.
+      When reading this file,
+      use the C locale.
+      Otherwise,
+      the contents may look different than they are.
+    </para>
+  </refsect1>
+
   <refsect1 id='see_also'>
     <title>SEE ALSO</title>
     <para>