nasm/doc
H. Peter Anvin 8d62e99e14 Add %note directive to add a note in the list file
This differs from a plain old comment in the following ways:

1. It is optionally macro-expanded;
2. It has a dash prefix;
3. It can be used inside .nolist macros.

Suggested-by: <pushbx@ulukai.org>
Resolves: https://bugzilla.nasm.us/show_bug.cgi?id=3392915
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2024-09-19 13:21:30 +02:00
..
16bit.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
32bit.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
64bit.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
afmmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
changelog.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
changes.src doc: improve the build from source documentation 2024-05-20 10:54:26 -07:00
contact.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
directiv.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07: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
index.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
inslist.pl doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
inslist.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
internal.doc Better explanation why insnsa.c is a separate module 2002-05-25 01:39:12 +00:00
intro.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
lang.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
local.css doc: add a local.css specifically to be overridden locally 2017-04-16 23:52:23 -07:00
macropkg.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
Makefile.in doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
mixsize.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
nasmdoc.css doc/nasmdoc.css: @media only print -> @media print 2024-04-25 15:42:25 -07:00
nasmdoc.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07: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
ndisasm.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
opt_var.txt Fix some typos 2022-01-09 17:34:35 +01:00
outfmt.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
preproc.src Add %note directive to add a note in the list file 2024-09-19 13:21:30 +02: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: break the documentation into chapters 2024-08-13 15:55:37 -07:00
README Document/update dependencies for the documentation 2017-05-02 13:01:59 -07:00
running.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
source.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
stdmac.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
trouble.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
ttfmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
warn.src doc: break the documentation into chapters 2024-08-13 15:55:37 -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