From owner-svn-doc-all@freebsd.org  Tue Nov  8 17:48:48 2016
Return-Path: <owner-svn-doc-all@freebsd.org>
Delivered-To: svn-doc-all@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 88D9CC371CC;
 Tue,  8 Nov 2016 17:48:48 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 584DC1C2;
 Tue,  8 Nov 2016 17:48:48 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id uA8HmlM8020988;
 Tue, 8 Nov 2016 17:48:47 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id uA8HmluI020986;
 Tue, 8 Nov 2016 17:48:47 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201611081748.uA8HmluI020986@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Tue, 8 Nov 2016 17:48:47 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r49651 - head/share/xml
X-SVN-Group: doc-head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-all@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "SVN commit messages for the entire doc trees \(except for &quot;
 user&quot; , &quot; projects&quot; , and &quot; translations&quot;
 \)" <svn-doc-all.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-all/>
List-Post: <mailto:svn-doc-all@freebsd.org>
List-Help: <mailto:svn-doc-all-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 08 Nov 2016 17:48:48 -0000

Author: mat
Date: Tue Nov  8 17:48:47 2016
New Revision: 49651
URL: https://svnweb.freebsd.org/changeset/doc/49651

Log:
  Add hints on how to add and sort man-ref entries.
  
  Sponsored by:	Absolight

Modified:
  head/share/xml/man-refs.ent
  head/share/xml/man-refs.pl

Modified: head/share/xml/man-refs.ent
==============================================================================
--- head/share/xml/man-refs.ent	Tue Nov  8 17:09:34 2016	(r49650)
+++ head/share/xml/man-refs.ent	Tue Nov  8 17:48:47 2016	(r49651)
@@ -21,6 +21,9 @@
      lexicographical order by the entity (i.e., the dots used in place of
      special characters should not be expanded when comparing).
 
+     This can be used to sort a section:
+     sed -E 's,.*refentrytitle>(.*)</refentrytit.*,\1 &,' | env LANG=C sort -u -k 1,1 | sed -Ee 's,[^ ]* [^ ]* ,,'
+
      $FreeBSD$
 -->
 

Modified: head/share/xml/man-refs.pl
==============================================================================
--- head/share/xml/man-refs.pl	Tue Nov  8 17:09:34 2016	(r49650)
+++ head/share/xml/man-refs.pl	Tue Nov  8 17:48:47 2016	(r49651)
@@ -1,5 +1,13 @@
 #!/usr/bin/perl -w
 # $FreeBSD$
+#
+# To get the entities sorted the same way as the current man-refs.ent file is, this command can be used:
+#
+# find -s /usr/share/man/ -name '*.gz' | \
+#   sed -Ee 's,.*([[:digit:]])/(.*)\.[^.]+\.gz,\1 \2 &,' | \
+#   env LANG=C sort -k 1,1n -k 2,2 | \
+#   sed -e 's/.* //' | \
+#   perl share/xml/man-refs.pl
 
 use strict;