40 Commits

Author SHA1 Message Date
G. Branden Robinson
b034532cb5 INSTALL.extra: Document chem's Perl module dep.
...on Math::Trig.

Thanks to Bruno Haible for the report.

https://lists.gnu.org/archive/html/groff/2026-01/msg00075.html
2026-01-21 11:36:12 -06:00
G. Branden Robinson
211291a0a3 INSTALL.extra: Document m4 build-time dependency.
Thanks to Bruno Haible for the report and a suggested clarification.

https://lists.gnu.org/archive/html/groff/2026-01/msg00075.html
2026-01-21 11:36:12 -06:00
G. Branden Robinson
f43b2b33a9 INSTALL.{REPO,extra}: Explain install-doc target. 2025-11-12 07:07:26 -06:00
G. Branden Robinson
a6755b558d INSTALL.extra: Document a glilypond dependency.
This has been the case for over 12 years, but as far as I can tell, no
one has ever complained--more evidence that glilypond lacks users, not
to mention an active developer.

(A shame, because the _idea_ is a good one.)
2025-08-02 06:16:40 -05:00
G. Branden Robinson
948376dcd7 INSTALL.extra: Clarify.
ECMA-48 may be better-known than ISO 6429; both codify the same facts.

(As far as I know.  The former is available gratis and I haven't shelled
out for the latter.)
2025-05-17 12:00:18 -05:00
G. Branden Robinson
923e992fb9 INSTALL.extra: Fix content nits.
* Drop unnecessary phrase.
* Drop stale text.
2024-08-28 20:08:00 -05:00
G. Branden Robinson
f7263c195d INSTALL.extra: Drop unnecessary instructions.
Components of groff embed nonstandard path components where necessary.
2024-03-31 18:14:46 -05:00
G. Branden Robinson
fbde1f13be [build]: Increment Perl dependency to 5.8.
...from 5.6.1.  gropdf requires 5.8 now.

* m4/groff.m4 (GROFF_PERL): Do it.

* INSTALL.extra:
* doc/webpage.ms: Document it.
2024-01-03 05:28:36 -06:00
G. Branden Robinson
e5f6d91b6d INSTALL.extra: Delete "Miscellaneous" section.
It was only about configuring the paper format.  We cover that in the
"PROBLEMS" file, section "Paper Format" of our Texinfo manual, and
subsection "Paper format" of groff(1).  Also, our Autoconf check and
summary report cover this ground now.
2023-08-28 14:46:45 -05:00
G. Branden Robinson
41cb28421a [docs]: Fix modifier placement. 2023-06-12 00:49:04 -05:00
G. Branden Robinson
48ac46ade7 INSTALL.extra: Drop Solaris 10 discussion.
We cover the matter of automated testing on Solaris 10 in detail in the
PROBLEMS file, which is already cross referenced from here.
2023-04-01 10:33:39 -05:00
G. Branden Robinson
5a420e557b INSTALL.extra: Fix documentary omission.
Dale Snell rightly points out that greater reader happiness will ensue
if the tbl-using document groff(1) actually gets preprocessed with tbl.

ANNOUNCE: Credit Dale.
2023-03-01 04:33:53 -06:00
G. Branden Robinson
57123c1a87 INSTALL.*: Advise use of 'install-doc' target.
Thanks to T. Kurt Bond for the suggestion.
2023-02-23 09:48:11 -06:00
G. Branden Robinson
dcd7768218 INSTALL.extra: Add advice for Solaris 10 users.
We can drop this in early 2024 when Oracle EOLs Solaris 10.

https://blogs.oracle.com/support/post/extended-support-for-oracle-solaris-10-operating-system
2023-02-15 11:52:39 -06:00
G. Branden Robinson
3d4249aa76 INSTALL.extra: Improve paper format advice. 2023-02-13 20:55:22 -06:00
G. Branden Robinson
46d60aac03 INSTALL.extra: Revise.
* Place "URW fonts" discussion into its own subsection due to length.
* Clarify that "test-groff" is located in the build directory.
2022-11-12 13:17:16 -06:00
G. Branden Robinson
5dbc158642 INSTALL.extra: Fix content and style nits.
* Clarify flexibility of source and build directory names.
* Add `GROFF_BIN_PATH` to list of environment variables that must be set
  to successfully run groff commands uninstalled.
* Add paragraph break.
* Quote name of "PROBLEMS" file.
* Advise people to use "BUG-REPORT" file as template on Savannah.
* Recast uninstallation instructions for symmetry with installation.
2022-10-29 12:52:02 -05:00
G. Branden Robinson
95d88768b2 INSTALL.extra: Clarify.
- Always quote "configure" when referring to the script of that name.
- Correct and expand discussion of gropdf and its 'Foundry' and
  'download' files.
2022-10-23 20:48:26 -05:00
G. Branden Robinson
a1b53a97da INSTALL.extra: Explain URW font optional dep. 2022-10-09 22:33:06 -05:00
G. Branden Robinson
cd6724c781 INSTALL.extra: Update out-of-tree build example.
Fix copy and paste error; use the example path to the source tree.
2022-08-05 00:03:05 -05:00
G. Branden Robinson
79ce39fff4 INSTALL.extra: Fix error in instructions. 2022-08-03 19:19:56 -05:00
G. Branden Robinson
1babd919ab INSTALL.extra: Update.
* Avoid chicken-and-egg problem by telling people without groff
  installed how to view the man page of the command of that name.
* Drop information about generation of our Texinfo manual's output
  formats.  They are all shipped with the distribution archive now.
* Add "Documentation" section heading.  Call out the compiled man page
  documents alongside our Texinfo manual.
* Encourage readers to search the Savannah bug tracker to avoid the
  filing of duplicate issues.
2022-05-24 11:19:43 -05:00
G. Branden Robinson
2d090cf7a0 INSTALL.extra: Add test suite usage advice.
* INSTALL.extra (In Case of Trouble): Add advice on using the test
  suite, particularly if it fails.

Fixes <https://savannah.gnu.org/bugs/?62478> (one hopes).
2022-05-21 11:13:08 -05:00
G. Branden Robinson
a16e98b982 INSTALL.extra: Fix style nit.
* Clarify: say "non-POSIX" instead of "special" platforms.
* Capitalize "Info" in "GNU Info".
* Tighten wording.
2022-05-21 11:13:08 -05:00
G. Branden Robinson
8439a00a92 INSTALL.extra: Tweak wording.
* Recast section headings to be more descriptive.
* Parallelize language between in-tree and out-of-tree build
  instructions.  They are now so similar that we might consider
  combining them.
* Fix capitalization error.
* Tighten wording.
2022-05-14 23:35:30 -05:00
G. Branden Robinson
825b39a71a INSTALL.REPO, INSTALL.extra: Update.
Bring discussion up to date.

INSTALL.REPO: Bump documented autoconf dependency.  Encourage use of
'-j' option to make(1), but stop explaining it--multicore machines are
standard these days and we can expect users building from Git to know
this.  Drop reassurance about transparent output-related diagnostics
since we have kludgily disabled them for the time being.  Drop
discussion of 'doc' and 'install-doc' targets since they have been
removed.  Drop discussion of autoreconf(1) since groff's migration to
Automake is a few years older now.  Fix error: automake.pdf _is_ built
by default; it's simply not installed.

INSTALL.extra: Encourage use of '-j' option to make(1).  Add discussion
of "unprivileged installation".  Simplify discussion of our Texinfo
manual's output formats since they're all shipped with the distribution
archive now.
2022-05-03 12:20:45 -05:00
G. Branden Robinson
83d8f0be03 INSTALL.extra: Add a section on uninstalling. 2022-03-26 21:24:05 +11:00
G. Branden Robinson
aa16fc0fe5 INSTALL.extra: Update discussion of dependencies.
* stdbool.h is a C99 feature, so call out C99 as a requirement.  gnulib
  might enable us to build even on C89/C90 systems, though.
* Record the release date for our Perl dependency, long since
  end-of-lifed even by ActiveState.
* Update discussion of our Texinfo manual since we no longer have a hard
  build-time dependency on 'makeinfo'.
* Tweak wording in uchardet and paper size discussions, including a
  Kemper notectomy and Kernighan ditroffectomy.
2022-03-02 20:56:50 +11:00
G. Branden Robinson
d877dee952 [docs]: Update installation instructions.
* INSTALL.REPO: Update characterization of our test repertoire.
* INSTALL.extra: Update documented compiler requirements; I don't think
  GCC 2.7.1 has been supported by anyone for many years.  Document
  ISO C++98 requirement.  Drop advice about use of alternative mallocs;
  I haven't seen any evidence of anyone doing this or suffering because
  they haven't.  Add guidance re: uchardet '-dev{,el}' packages per
  suggestion from Deri James.  Fix error: "latin1" is a groff device;
  "latin" is not.

Also fix minor style nits (capitalization, quotation style).
2021-10-16 15:43:55 +11:00
G. Branden Robinson
990d0ca95a INSTALL.extra: Show how to preview Info doc. 2021-04-29 14:08:27 +10:00
G. Branden Robinson
3e280a1408 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>.
2021-04-22 21:08:40 +10:00
Bertrand Garrigues
c05b538c50 Update copyright
* update-copyright.sh: use gnulib's 'update-copyright' script.  Pass
  this script in directories 'arch', 'contrib', 'font', 'man', 'tmac',
  'src' and on a list of extra files.

* FOR-RELEASE: mention this point.
2020-11-11 23:08:05 +01:00
Bertrand Garrigues
54f7ea974e Revert "Update copyright"
This reverts commit a2e955e07354c83939fabffebcf720d3333d1f6b.

Some files (COPYING, FDL, bootstrap) should not have been updated
2020-10-25 22:19:26 +01:00
Bertrand Garrigues
a2e955e073 Update copyright
Use gnulib's update-copyright script.

* src/roff/groff/groff.cpp: update the printf displayed when 'groff -v' is invoked.

* FOR-RELEASE: mention this point.
2020-10-25 01:54:21 +02:00
G. Branden Robinson
72891af00c Synchronize Emacs and Vim editor settings.
Also add some settings (mainly fill columns and character encoding
hints) to try to prevent chaos.

Gory details follow.

* ChangeLog.115:
* ChangeLog.116:
* ChangeLog.117:
* ChangeLog.118:
* ChangeLog.119:
* ChangeLog.120:
* ChangeLog.121:
* Makefile.am:
* arch/mingw/mingw.am:
* arch/misc/misc.am:
* contrib/chem/chem.am:
* contrib/chem/chem.pl:
* contrib/eqn2graph/eqn2graph.am:
* contrib/gdiffmk/ChangeLog:
* contrib/gdiffmk/gdiffmk.am:
* contrib/glilypond/ChangeLog:
* contrib/glilypond/ChangeLog.0x:
* contrib/glilypond/args.pl:
* contrib/glilypond/glilypond.am:
* contrib/glilypond/glilypond.pl:
* contrib/glilypond/oop_fh.pl:
* contrib/glilypond/subs.pl:
* contrib/gperl/gperl.am:
* contrib/gpinyin/ChangeLog:
* contrib/gpinyin/gpinyin.am:
* contrib/gpinyin/gpinyin.pl:
* contrib/gpinyin/subs.pl:
* contrib/grap2graph/grap2graph.am:
* contrib/groff_filenames/ChangeLog:
* contrib/groff_filenames/groff_filenames.am:
* contrib/hdtbl/ChangeLog:
* contrib/hdtbl/hdtbl.am:
* contrib/mm/mm.am:
* contrib/mom/ChangeLog:
* contrib/mom/mom.am:
* contrib/pdfmark/ChangeLog:
* contrib/pdfmark/pdfmark.am:
* contrib/pic2graph/pic2graph.am:
* font/devX100-12/devX100-12.am:
* font/devX100/devX100.am:
* font/devX75-12/devX75-12.am:
* font/devX75/devX75.am:
* font/devascii/devascii.am:
* font/devcp1047/devcp1047.am
* font/devdvi/devdvi.am:
* font/devlbp/devlbp.am:
* font/devlj4/devlj4.am:
* font/devpdf/devpdf.am:
* font/devps/devps.am:
* font/devutf8/devutf8.am:
* font/scripts/scripts.am:
* man/man.am:
* src/include/include.am:
* src/libs/libbib/libbib.am:
* src/libs/libdriver/libdriver.am:
* src/libs/libgroff/libgroff.am:
* src/libs/libxutil/libxutil.am:
* src/roff/groff/groff.am:
* src/roff/grog/grog.am:
* src/roff/nroff/nroff.am:
* src/roff/troff/troff.am:
* src/utils/addftinfo/addftinfo.am:
* src/utils/afmtodit/afmtodit.am:
* src/utils/hpftodit/hpftodit.am:
* tmac/tmac.am:
  Tell Vim to auto-indent the file.

* BUG-REPORT:
* ChangeLog.115:
* ChangeLog.116:
* ChangeLog.117:
* ChangeLog.118:
* ChangeLog.119:
* ChangeLog.120:
* ChangeLog.121:
* INSTALL.extra:
* Makefile.am:
* arch/mingw/mingw.am:
* arch/misc/misc.am:
* contrib/chem/README.txt:
* contrib/chem/chem.pl:
* contrib/chem/examples/122/ch2a_ethyl.chem:
* contrib/chem/examples/122/ch4a_stick.chem:
* contrib/chem/examples/122/ch4j_ring4.chem:
* contrib/chem/examples/README.txt:
* contrib/chem/examples/atp.chem:
* contrib/chem/examples/cholesterin.chem:
* contrib/chem/examples/ethamivan.chem:
* contrib/chem/examples/lsd.chem:
* contrib/chem/examples/reserpine.chem:
* contrib/eqn2graph/eqn2graph.am:
* contrib/gdiffmk/ChangeLog:
* contrib/gdiffmk/README:
* contrib/gdiffmk/gdiffmk.am:
* contrib/glilypond/ChangeLog:
* contrib/glilypond/ChangeLog.0x:
* contrib/glilypond/README.txt:
* contrib/glilypond/args.pl:
* contrib/glilypond/glilypond.pl:
* contrib/glilypond/oop_fh.pl:
* contrib/glilypond/subs.pl:
* contrib/gpinyin/ChangeLog:
* contrib/gpinyin/gpinyin.pl:
* contrib/gpinyin/subs.pl:
* contrib/grap2graph/grap2graph.am:
* contrib/groff_filenames/ChangeLog:
* contrib/hdtbl/ChangeLog:
* contrib/mm/mm.am:
* contrib/mom/ChangeLog:
* contrib/mom/mom.am:
* contrib/pdfmark/ChangeLog:
* contrib/pic2graph/pic2graph.am:
  Set fill column to 72.

* ChangeLog.116:
* ChangeLog.117:
* ChangeLog.118:
* ChangeLog.119:
* ChangeLog.120:
* ChangeLog.121:
* contrib/gdiffmk/ChangeLog:
* contrib/glilypond/ChangeLog:
* contrib/glilypond/ChangeLog.0x:
* contrib/groff_filenames/ChangeLog:
* contrib/hdtbl/ChangeLog:
* contrib/mom/ChangeLog:
* contrib/pdfmark/ChangeLog:
  Sort Emacs local variables lexicographically.

* ChangeLog.115:
* ChangeLog.116:
* ChangeLog.117:
* ChangeLog.118:
* ChangeLog.119:
* ChangeLog.120:
* ChangeLog.121:
  Tell Emacs the file is a change-log.

* Makefile.am:
* arch/mingw/mingw.am:
* arch/misc/misc.am:
* contrib/eqn2graph/eqn2graph.am:
  Tell Vim the file is an Automake file (it detects at least some
  in-tree *.am files as ordinary Makefiles).

* ChangeLog.115:
* contrib/gdiffmk/ChangeLog:
* contrib/pdfmark/ChangeLog:
  Remove Emacs coding declaration.  No non-ASCII characters are present.

* BUG-REPORT:
  Prevent Vim filetype detection (Vim thinks it's a generic
  configuration file due to the hash-commented legal notice).

* contrib/glilypond/ChangeLog.0x:
  Tell Emacs the file is a "change-log" (not "change-log-mode").

* contrib/glilypond/README.txt:
  Comment the editor settings as is done in top-level plain text
  documentation.

* contrib/gpinyin/ChangeLog:
  Set Emacs "version-control" variable to "never", in parallel with
  ChangeLog files elsewhere.  (I'm not sure this is necessary with Git,
  however; maybe we should be removing them everywhere.  If so, that's
  easy to sed.)
2020-04-30 07:30:51 +10:00
G. Branden Robinson
300ebcf4a3 Make settings comment in text files ecumenical.
Vim modelines go at the end of the file as well.
2020-04-19 09:31:37 +10:00
G. Branden Robinson
986d2a5b2d Require Texinfo 5.0 (February 2013) at a minimum.
* m4/groff.m4 (GROFF_MAKEINFO): Check for version 5.0 (increased from
  4.8).  Update diagnostics and comments.

* INSTALL.extra:
* README:
* doc/groff.texi:
* doc/webpage.ms: Document updated requirement.

* doc/fixinfo.sh: Delete; it is no longer necessary to work around
  Texinfo 4.x bugs.

* doc/doc.am (EXTRA_DIST): Stop shipping fixinfo.sh.
  (.texi.html): Remove makeinfo < 5.0 version check and consequent
  execution of fixinfo.sh.  Update comment.
2020-04-11 12:56:12 +10:00
G. Branden Robinson
81f7ba3bc0 Remove instructions to file bugs via bug-groff.
Patch courtesy of Dave Kemper.  His comments, massaged into GNU
	changelog format, follow.

	[The patch] also fixes a couple of trivial errors in grammar,
	punctuation, etc., that I spotted in the process[].

	* PROJECTS: Since the context of bug-groff@gnu.org in this file
	is not reporting bugs, instead of changing it to point to the
	bug tracker, I changed the address to that of the groff
	discussion list.  (However, I don't know whether this list is
	configured to accept email from nonsubscribers, so this may not
	be a viable change.)

	* README:
	* doc/webpage.ms: These files already recommended the bug tracker
	as the bug-reporting mechanism; they said using the method in
	the file BUG-REPORT was an alternative.  As BUG-REPORT also now
	points to the bug tracker, I've tweaked this wording.

	* doc/groff.texi: The address bug-groff@gnu.org was used only
	once in this file, not as an address to report bugs, but as the
	email address for Werner Lemberg.  I would take this to mean he
	doesn't want his actual email address in public documentation,
	except that it appears in many other places throughout groff
	source code and documentation alike.  So it doesn't seem
	unreasonable to put it in this file as well.  I will email him
	to confirm that this is OK. [I went ahead and removed it; we
	don't need an email address in the document, IMO. --GBR]

	* INSTALL.extra: Like README, this cited the file BUG-REPORT as
	an alternative mechanism. I removed this wording entirely.

	* BUG-REPORT:
	* contrib/groffer/README:
	* contrib/mm/README:
	* contrib/mm/m.tmac:
	* contrib/mm/mm/0.MT:
	* contrib/mm/mm/4.MT:
	* contrib/mm/mm/5.MT:
	* contrib/mm/mm/ms.cov:
	* contrib/mm/mse.tmac:
	* src/devices/xditview/README: Tweak wording and direct readers
	to Savannah bug tracker instead of bug-groff mailing list.

Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>
2018-11-06 09:02:09 -05:00
Bertrand Garrigues
6d41249a8c Update installation doc.
* INSTALL.REPO: mention that 'pkg-config' is a dependency.

* INSTALL.extra: add dependency 'makeinfo' and optional
dependencies 'pkg-config' and 'uchardet'.

* TESTS: move to doc/automake_migration_tests.txt

* INSTALL.gen: remove, this file is redundant with the 'INSTALL'
file from gnulib.
2018-02-26 22:51:10 +01:00
Bertrand Garrigues
5fec19d453 Gnulib integration
Applied the following command:

  git submodule add git://git.sv.gnu.org/gnulib.git

This added gnulib in .git/index and created an empty `gnulib'
directory.  This directory contains all the gnulib code, but is not
distributed. gnulib m4 dir are now in `gnulib_m4', while gnulib .c
files are located in `lib'.  `gnulib_m4' and `lib' are generated and
distributed.

* .gitsubmodules: new file.
* src/libs/gnulib: removed.

Minimal Automake support.  Makefile in non-recursive style.

Removed old build system Makefile.*.  Removed various files that are
now generated by the bootstrap script: `configure',
`src/include/config.hin', various helper scripts (`config.guess',
`config.rpath' etc...) that are now installed by in `build-aux'.
Added the minimal code in Makefile.am to build the gnulib.

* Makefile.am: new file (moved and adapted from Makefile.in).
* acinclude.m4: new file (moved from aclocal.m4, which is now generated).
* INSTALL.extra: new file (moved from the original INSTALL file, which
  is now a symlink to gnulib/doc/INSTALL).
* THANKS, AUTHORS: new empty files.
* TESTS: new file to sum up the tests that were done for the Automake
  migration.
2015-01-27 23:13:13 +01:00