nasm/doc
H. Peter Anvin f7163e343c doc: allow replicated index entries (\IR), make index sorting smarter
Allow a single index entry key to be defined with \IR more than once,
generating multiple entries in the index; this is really useful for
example to always generate "macros, single-line" and "single-line
macros" entries sorted at different places.

Be smarter about sorting the index: sort (nearly) all special
characters before alphanumerics, and (attempt to) sort numbers in
numerical order rather than alphabetical (so BITS8 sorts before
BITS16).

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2022-11-09 18:38:45 -08:00
..
afmmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
changes.src rdoff: kill it off 2022-11-07 16:49:13 -08:00
findfont.ph doc: fix yet another set of Ghostscript font problems 2019-06-06 20:51:10 -07:00
genps.pl doc/genps.pl: handle large lists of index entries 2022-11-08 15:24:24 -08:00
head.ps doc: actually *use* the smaller code font size... 2020-06-27 23:10:50 -07:00
inslist.pl doc: clean up the instruction list in the documentation slightly 2017-04-07 09:51:24 -07:00
internal.doc Better explanation why insnsa.c is a separate module 2002-05-25 01:39:12 +00:00
local.css doc: add a local.css specifically to be overridden locally 2017-04-16 23:52:23 -07:00
Makefile.in Makefile portability improvement, build nasmdoc.pdf.xz 2020-05-26 14:13:31 -07:00
nasmdoc.css nasmdoc.css: use a relative size for code/pre 2020-06-27 23:18:28 -07:00
nasmdoc.src doc: move instruction list to the end 2022-11-08 18:40:11 -08:00
nasmlogo.eps doc: New NASM logo 2012-02-25 14:53:34 -08:00
nasmlogw.png doc: add indented paragraphs, valid XHTML, CSS style sheet 2017-04-13 22:12:05 -07:00
opt_var.txt Fix some typos 2022-01-09 17:34:35 +01:00
psfonts.ph psfonts.ph: add more font aliases 2022-11-08 15:12:31 -08:00
pspdf.pl Fix some typos 2022-01-09 17:34:35 +01:00
pswidth.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
rdsrc.pl doc: allow replicated index entries (\IR), make index sorting smarter 2022-11-09 18:38:45 -08:00
README Document/update dependencies for the documentation 2017-05-02 13:01:59 -07:00
ttfmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00

To build the entire documentation, the following tools are needed:

1. A Perl interpreter for your platform
2. The following Perl modules available from CPAN:
   Font::TTF
   Sort::Versions
3. asciidoc
   http://asciidoc.org/
4. xmlto
   https://fedorahosted.org/xmlto
5. One of:
	Adobe Acrobat (acrodist)
	Ghostscript (ps2pdf) http://download.ghostscript.com/
	pstopdf	(available on some BSD-derived Unix systems)

	Of these, Ghostscript is the most tested, although Acrobat has
	been claimed to generate smaller files.
6. For best results, the Adobe fonts Source Sans Pro and Source Code
   Pro, available for free at:
   https://github.com/adobe-fonts