nasm/doc
H. Peter Anvin 1fd289c340 doc: cccl for compiling with MSVC, source build section edits
Make a note about the availability of the cccl wrapper for building
with MSVC using GNU make.

Minor tidying up of the building from source section in general.

Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2025-09-25 12:08:58 -07:00
..
16bit.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
32bit.src doc: tweaks to the index 2025-09-05 17:51:38 -07:00
64bit.src doc: add 2.17 release notes and document [dollarhex] 2025-09-03 12:31:03 -07:00
afmmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
apx.src doc: fix instruction spelling: PPUSH -> PUSHP et al 2025-09-23 16:00:24 -07:00
changelog.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
changes.src preproc: implement %hs2b() and %b2hs() functions for compact binary data 2025-09-15 23:01:59 -07:00
contact.src doc: tweaks to the index 2025-09-05 17:51:38 -07:00
directiv.src doc: remove & used for list 2025-09-14 23:52:22 -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: tidy up the APX documentation and a few other minor changes 2025-09-23 12:00:31 -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: tweaks to the index 2025-09-05 17:51:38 -07:00
lang.src doc: tidy up the APX documentation and a few other minor changes 2025-09-23 12:00:31 -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: tidy up the APX documentation and a few other minor changes 2025-09-23 12:00:31 -07:00
Makefile.in doc: update the documentation, and auto-generate some indexes 2025-09-05 17:12:06 -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: document that appendices C, D and E should be unchanged 2025-09-23 08:13:48 -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 preproc: add __?DEFAULT?__ macro representing the DEFAULT settings 2025-09-14 00:38:50 -07:00
preproc.src doc: tidy up the APX documentation and a few other minor changes 2025-09-23 12:00:31 -07: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: cccl for compiling with MSVC, source build section edits 2025-09-25 12:08:58 -07:00
README Document/update dependencies for the documentation 2017-05-02 13:01:59 -07:00
running.src doc: tidy up the APX documentation and a few other minor changes 2025-09-23 12:00:31 -07:00
source.src doc: cccl for compiling with MSVC, source build section edits 2025-09-25 12:08:58 -07:00
stdmac.src doc: describe caveat with old NASM and new %if directives 2025-09-14 04:07:19 -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