groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 02/05: INSTALL.extra: Update.


From: G. Branden Robinson
Subject: [groff] 02/05: INSTALL.extra: Update.
Date: Thu, 22 Apr 2021 08:12:08 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 3e280a14083ace2d1baeb93bb2f73805d5acda29
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Apr 22 21:08:40 2021 +1000

    INSTALL.extra: Update.
    
    * INSTALL.extra: Update.
      (Evaluation): New section updates material on "test-groff" script.
      Also tell people how to preview our Texinfo manual (in text, DVI, PDF,
      and HTML formats).
    
      (In Case of Trouble): New section updates bug reporting URL.
    
    Fixes <https://savannah.gnu.org/bugs/?57863>.
---
 ChangeLog     | 10 ++++++++++
 INSTALL.extra | 51 ++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 48 insertions(+), 13 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ce6085b..2cda034 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2021-04-22  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       * INSTALL.extra: Update.
+       (Evaluation): New section updates material on "test-groff"
+       script.  Also tell people how to preview our Texinfo manual (in
+       text, DVI, PDF, and HTML formats).
+       (In Case of Trouble): New section updates bug reporting URL.
+
+       Fixes <https://savannah.gnu.org/bugs/?57863>.
+
 2021-04-21  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        * tmac/s.tmac: Make the FAM string work more sensibly; it now
diff --git a/INSTALL.extra b/INSTALL.extra
index 6df8953..968591a 100644
--- a/INSTALL.extra
+++ b/INSTALL.extra
@@ -1,4 +1,4 @@
-    Copyright 1997-2020 Free Software Foundation, Inc.
+    Copyright 1997-2021 Free Software Foundation, Inc.
 
     Copying and distribution of this file, with or without modification,
     are permitted in any medium without royalty provided the copyright
@@ -122,27 +122,52 @@ can be still overridden on the command line).  For 
compatibility with
 ditroff, the default page length in gtroff is always 11 inches.  The
 page length can be changed with the `pl' request.
 
-When you have built groff but not installed yet, you can use the
-test-groff script to try groff out on one of the man pages.  (Use the
-.n files not the .man files.)  The test-groff script sets up environment
-variables to allow groff to run without being installed.  For example,
-you could do
 
-  ./test-groff -man -Tascii src/roff/groff/groff.n | less
+Evaluation
+==========
 
-to display the groff(1) man page with the `less' pager.
+Once groff is built, you can check it for correct operation without
+having to install it.  groff comes with a test suite; use `make check'
+to run it.
+
+You can also try it out from the directory you used to build it.  A
+script called `test-groff' is supplied for this purpose.  It sets up
+environment variables to allow groff to run without being installed.
+For example, the command
+
+  ./test-groff -man -Tascii src/roff/groff/groff.1 | less -R
+
+displays the groff(1) man page with the `less' pager.  (You might prefer
+either the `-Tlatin' or `-Tutf8' option to `-Tascii' depending on the
+character set you're using.)
+
+The groff texinfo manual in GNU info format has to be installed to be
+usable by the info(1) command or Emacs's info mode, but it can be viewed
+as text as well (albeit text encoded in ISO Latin-1).
+
+  iconv -f latin1 -t utf8 doc/groff.txt | less # for UTF-8 users
+  less doc/groff.txt # for Latin-1 users
 
 To get a DVI, PDF, or HTML version of the groff texinfo manual, say
 `make groff.dvi', `make groff.pdf', or `make groff.html', respectively,
-in the `doc' subdirectory (after configuring the groff package).  Note
-that you need texinfo version 5.0 as a prerequisite.
+in the `doc' subdirectory (after configuring the groff package).
+Texinfo version 5.0 or later is a prerequisite for generation of these
+formats.  Here are some ways you might view the documents produced.
+
+  xdvi doc/groff.dvi
+  evince doc/groff.pdf
+  lynx doc/groff.html
+
+
+In Case of Trouble
+==================
 
 If you have problems, read the PROBLEMS file.  If this doesn't help
 and you need support, please contact the `groff' mailing list.  If you
-think that you have found a bug, please submit a report in our bug
-tracker at
+think that you have found a bug, please submit a report to our bug
+tracker.
 
-  https://savannah.gnu.org/projects/groff
+  https://savannah.gnu.org/bugs/?group=groff&func=additem
 
 ##### Editor settings
 Local Variables:



reply via email to

[Prev in Thread] Current Thread [Next in Thread]