diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 9cb4e6b2..0eef5285 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -175,7 +175,9 @@ function(add_doc TARGET SOURCE DEPS) COMMAND sh ${CMAKE_CURRENT_SOURCE_DIR}/script/groff.sh -T ps # Output device + -d paper=a4 -P-pa4 # Consistent paper size -man # Macro Package man + -m pdfmark # Macro Package pdfmark # Order of preprocessors may be important -t # Preprocess with tbl -s # Preprocess with soelim, with search paths: diff --git a/doc/dictionaries/names.txt b/doc/dictionaries/names.txt index bc5dcd6e..844eb274 100644 --- a/doc/dictionaries/names.txt +++ b/doc/dictionaries/names.txt @@ -91,6 +91,7 @@ oceanofthelost opensource Ozcelik patryks +pdfmark Pilkington Pkzip Platon diff --git a/doc/dictionaries/troff.txt b/doc/dictionaries/troff.txt index 9f11d7a4..00c7c9f2 100644 --- a/doc/dictionaries/troff.txt +++ b/doc/dictionaries/troff.txt @@ -32,3 +32,7 @@ Pmkdir Ppacman Psrec Psudo +pdfbookmark +pdfinfo +pdfsync +pdfview diff --git a/doc/etc/BUILDING.man b/doc/etc/BUILDING.man index b178d009..4c99f84f 100644 --- a/doc/etc/BUILDING.man +++ b/doc/etc/BUILDING.man @@ -17,12 +17,18 @@ .\" .TH Build SRecord SRecord "Reference Manual" .so etc/version.so +.pdfinfo /Title SRecord Build Instructions +.pdfinfo /Author Scott Finneran, Peter Miller +.pdfinfo /Subject How to build SRecord version \*(V) [\*(G)] +.pdfinfo /Keywords SRecord setup building testing installing packaging +.pdfsync +.\" --------------------------------------------------------------------------- .if n .hy 0 .if n .ad l .if n .nr IN 8n +.XX "" "How to build SRecord" .SH NAME How to build SRecord -.XX "" "How to build SRecord" .SH SPACE REQUIREMENTS You will need about 3MB to unpack and build the .I SRecord diff --git a/doc/etc/README.man b/doc/etc/README.man index a8f39d28..dc0b7acd 100644 --- a/doc/etc/README.man +++ b/doc/etc/README.man @@ -17,11 +17,17 @@ .\" .TH "Read Me" SRecord SRecord "Reference Manual" .so etc/version.so +.pdfinfo /Title SRecord Read Me +.pdfinfo /Author Scott Finneran, Peter Miller +.pdfinfo /Subject Overview of SRecord version \*(V) [\*(G)] +.pdfinfo /Keywords SRecord README changelog releases +.pdfsync +.\" --------------------------------------------------------------------------- .hy 0 .ad l +.XX "" "The README file" .SH NAME SRecord \- manipulate EPROM load files -.XX "" "The README file" .SH DESCRIPTION The \f[I]SRecord\fP package is a collection of powerful tools for manipulating EPROM load files. @@ -421,8 +427,8 @@ Peter Miller;E\[hy]Mail:;pmiller@opensource.org.au .TE .br .bp -.SH RELEASE NOTES .XX "" "Release Notes" +.SH RELEASE NOTES This section details the various features and bug fixes of the various releases. For excruciating and complete detail, and also credits for those of you who have generously sent me suggestions and bug reports, diff --git a/doc/etc/change_log.man b/doc/etc/change_log.man index ec2921fc..b99efa9a 100644 --- a/doc/etc/change_log.man +++ b/doc/etc/change_log.man @@ -18,6 +18,12 @@ .\" .TH "Change Log" SRecord SRecord "Change Log" .so etc/version.so +.pdfinfo /Title SRecord Change Log +.pdfinfo /Author Scott Finneran, Peter Miller +.pdfinfo /Subject Release notes up to SRecord version \*(V) [\*(G)] +.pdfinfo /Keywords SRecord changelog releases +.pdfsync +.\" --------------------------------------------------------------------------- .hy 0 .ad l .SH RELEASE NOTES diff --git a/doc/etc/new-file-format.so b/doc/etc/new-file-format.so index 1de7c6cc..2486e1aa 100644 --- a/doc/etc/new-file-format.so +++ b/doc/etc/new-file-format.so @@ -17,9 +17,9 @@ .\" . .\" .TH "New Format" "SRecord" "SRecord" "Reference Manual" +.XX "" "How to add a new file format" .SH NAME How to add a new file format -.XX "" "How to add a new file format" .SH DESCRIPTION This section describes how to add a new file format. It's mostly a set of reminders for the maintainer. If you want a format added to diff --git a/doc/etc/new-filter.so b/doc/etc/new-filter.so index f9eda567..84ebd3ff 100644 --- a/doc/etc/new-filter.so +++ b/doc/etc/new-filter.so @@ -17,9 +17,9 @@ .\" . .\" .TH "New Filter" "SRecord" "SRecord" "Reference Manual" +.XX "" "How to add a new filter" .SH NAME How to add a new filter -.XX "" "How to add a new filter" .SH DESCRIPTION This section describes how to add a new filter. It's mostly a set of reminders for the maintainer. If you want a filter added to the diff --git a/doc/etc/ref-toc.so b/doc/etc/ref-toc.so index 73152010..6895d96d 100644 --- a/doc/etc/ref-toc.so +++ b/doc/etc/ref-toc.so @@ -22,6 +22,7 @@ .\" arguments, first is the page title, the second is the page .\" description. The current page number in the \n% register is .\" consulted to obtain the page number. +.\" Also the PDF outline entries are inserted here. .\" .de XX .ds Page*Of*\\$1 \\n% @@ -37,6 +38,8 @@ .rm toc*num .ev .di +.ie '\?\\$1\?'\?\?' .pdfbookmark 1 \\$2 +.el .pdfbookmark 1 \\$1 - \\$2 .. .\" ---------- TC ----------------------------------------------------------- .\" diff --git a/doc/etc/reference.man b/doc/etc/reference.man index d0f4f01d..05bb8ab8 100644 --- a/doc/etc/reference.man +++ b/doc/etc/reference.man @@ -115,11 +115,31 @@ with this program. If not, see . .\" .so etc/ref-parts.so .\" +.\" ---------- Add the PDF metadata ----------------------------------------- +.\" +.\" After inclusion of README/BUILDING to overwrite their metadata. +.pdfinfo /Title SRecord Reference Manual +.pdfinfo /Author Scott Finneran, Peter Miller +.pdfinfo /Subject Detailed description of SRecord version \*(V) [\*(G)] +.pdfinfo /Keywords SRecord srec_cat srec_cmp srec_info +.\" +.\" Request to display the outline by default. +.pdfview /PageMode /UseOutlines +.\" +.\" ---------- Flush the pdfmark cache --------------------------------------- +.\" +.\" Before the TOC to avoid wrong output when moving the TOC up with psselect: +.\" - metadata would contain BUILDING's values otherwise +.\" - the last PDF outline entry would wrongly be positioned at the beginning +.pdfsync +.\" .\" ---------- Include the Table of Contents -------------------------------- .\" .if o .bp \" because .TH is going to throw another one .nr % 1000 .TH "Table of Contents" "SRecord" "SRecord" "Reference Manual" +.pdfbookmark 1 Table of Contents +.pdfsync .\" .\" ----- .\" This next section redefines the page footer to use roman numbering diff --git a/doc/man1/srec_cat.1 b/doc/man1/srec_cat.1 index 0b91733e..06821179 100644 --- a/doc/man1/srec_cat.1 +++ b/doc/man1/srec_cat.1 @@ -18,11 +18,11 @@ .\" .ds n) srec_cat .TH \*(n) 1 SRecord "Reference Manual" -.SH NAME -srec_cat \- manipulate EPROM load files .if require_index \{ .XX "srec_cat(1)" "Manipulate EPROM load files" .\} +.SH NAME +srec_cat \- manipulate EPROM load files .SH SYNOPSIS .B \*(n) [ diff --git a/doc/man1/srec_cmp.1 b/doc/man1/srec_cmp.1 index 385494bb..3ee28268 100644 --- a/doc/man1/srec_cmp.1 +++ b/doc/man1/srec_cmp.1 @@ -17,11 +17,11 @@ .\" .ds n) srec_cmp .TH \*(n) 1 SRecord "Reference Manual" -.SH NAME -srec_cmp \- compare two EPROM load files for equality .if require_index \{ .XX "srec_cmp(1)" "Compare two EPROM load files for equality" .\} +.SH NAME +srec_cmp \- compare two EPROM load files for equality .SH SYNOPSIS .B \*(n) [ diff --git a/doc/man1/srec_examples.1 b/doc/man1/srec_examples.1 index a04e0775..6f1e0c26 100644 --- a/doc/man1/srec_examples.1 +++ b/doc/man1/srec_examples.1 @@ -17,11 +17,11 @@ .\" .ds n) srec_cat .TH srec_examples 1 SRecord "Reference Manual"i -.SH NAME -srec_examples \- examples of how to use SRecord .if require_index \{ .XX "srec_examples(1)" "Examples of how to use SRecord" .\} +.SH NAME +srec_examples \- examples of how to use SRecord .SH DESCRIPTION The \f[I]srec_cat\fP command is very powerful, due to the ability to combine the the input filters in almost unlimited ways. diff --git a/doc/man1/srec_info.1 b/doc/man1/srec_info.1 index 9cbeadfe..1bbb1239 100644 --- a/doc/man1/srec_info.1 +++ b/doc/man1/srec_info.1 @@ -18,11 +18,11 @@ .\" .ds n) srec_info .TH \*(n) 1 SRecord "Reference Manual" -.SH NAME -srec_info \- information about EPROM load files .if require_index \{ .XX "srec_info(1)" "Information about EPROM load files" .\} +.SH NAME +srec_info \- information about EPROM load files .SH SYNOPSIS .B \*(n) [ diff --git a/doc/man1/srec_input.1 b/doc/man1/srec_input.1 index 0973288b..821274b6 100644 --- a/doc/man1/srec_input.1 +++ b/doc/man1/srec_input.1 @@ -17,11 +17,11 @@ .\" .ds n) srec_input .TH \*(n) 1 SRecord "Reference Manual" -.SH NAME -\*(n) \- input file specifications .if require_index \{ .XX "srec_input(1)" "Input file specifications" .\} +.SH NAME +\*(n) \- input file specifications .SH SYNOPSIS \f[B]srec_*\fP \f[I]filename\fP [ \f[I]format\fP ] .SH DESCRIPTION diff --git a/doc/man1/srec_license.1 b/doc/man1/srec_license.1 index 372a0a8d..c446443f 100644 --- a/doc/man1/srec_license.1 +++ b/doc/man1/srec_license.1 @@ -1,11 +1,11 @@ .TH GPL GNU GPL GNU "Free Software Foundation" +.if require_index \{ +.XX "srec_license(1)" "GNU General Public License" +.\} .PP .ce 2 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 -.if require_index \{ -.XX "srec_license(1)" "GNU General Public License" -.\} .PP Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies diff --git a/doc/man3/srecord.3 b/doc/man3/srecord.3 index e8dcff57..67bba676 100644 --- a/doc/man3/srecord.3 +++ b/doc/man3/srecord.3 @@ -17,11 +17,11 @@ .\" .ds n) srecord .TH \*(n) 3 SRecord "Reference Manual" -.SH NAME -srecord \- library to manipulate EPROM load files .if require_index \{ .XX "srecord(3)" "Library to manipulate EPROM load files" .\} +.SH NAME +srecord \- library to manipulate EPROM load files .SH SYNOPSIS #include .sp diff --git a/doc/man3/srecord_license.3 b/doc/man3/srecord_license.3 index d138fcac..d4e8f590 100644 --- a/doc/man3/srecord_license.3 +++ b/doc/man3/srecord_license.3 @@ -1,4 +1,7 @@ .TH LGPL 3 LGPL GNU "Free Software Foundation" +.if require_index \{ +.XX "srecord_license(3)" "GNU Lesser General Public License" +.\} .SH NAME LGPG \- GNU Lesser General Public License .SH DESCRIPTION @@ -6,9 +9,6 @@ LGPG \- GNU Lesser General Public License .ce 2 GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 -.if require_index \{ -.XX "srecord_license(3)" "GNU Lesser General Public License" -.\} .PP Copyright (C) 2007 Free Software Foundation, Inc. .br diff --git a/doc/man5/srec_aomf.5 b/doc/man5/srec_aomf.5 index 97d6c386..e1b6561f 100644 --- a/doc/man5/srec_aomf.5 +++ b/doc/man5/srec_aomf.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_aomf .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_aomf \- Intel Absolute Object Module Format .if require_index \{ .XX "srec_aomf(5)" "Intel Absolute Object Module Format" .\} +.SH NAME +srec_aomf \- Intel Absolute Object Module Format .SH DESCRIPTION The Absolute Object Module Format (AOMF) is a subset of the 8051 OMF. The structure of an absolute object file (the order of the records in diff --git a/doc/man5/srec_ascii_hex.5 b/doc/man5/srec_ascii_hex.5 index 63e44db7..76b1c6e6 100644 --- a/doc/man5/srec_ascii_hex.5 +++ b/doc/man5/srec_ascii_hex.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_ascii_hex .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_ascii_hex \- Ascii\[hy]Hex file format .if require_index \{ -.XX "srec_ascii_hex(5)" "Ascii\[hy]Hex file format" +.XX "srec_ascii_hex(5)" "Ascii-Hex file format" .\} +.SH NAME +srec_ascii_hex \- Ascii\[hy]Hex file format .SH DESCRIPTION This format is also known as the \fIAscii\[hy]Space\[hy]Hex\fP or \fIAscii\[hy]Hex\[hy]Space\fP format. diff --git a/doc/man5/srec_atmel_generic.5 b/doc/man5/srec_atmel_generic.5 index 921bcd18..7f048742 100644 --- a/doc/man5/srec_atmel_generic.5 +++ b/doc/man5/srec_atmel_generic.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_atmel_generic .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_atmel_generic \- Atmel Generic file format .if require_index \{ .XX "srec_atmel_generic(5)" "Atmel Generic file format" .\} +.SH NAME +srec_atmel_generic \- Atmel Generic file format .SH DESCRIPTION This format is the output of the Atmel AVR assembler. The file contains two columns of hexadecimal coded values. diff --git a/doc/man5/srec_binary.5 b/doc/man5/srec_binary.5 index 66702dcb..a0e825e7 100644 --- a/doc/man5/srec_binary.5 +++ b/doc/man5/srec_binary.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_binary .TH srec_binary 5 SRecord "Reference Manual" -.SH NAME -srec_binary \- binary file format .if require_index \{ .XX "srec_binary(5)" "Binary file format" .\} +.SH NAME +srec_binary \- binary file format .SH DESCRIPTION It is possible to read and write binary files using \f[I]srec_cat\fP(1). .SS File Holes diff --git a/doc/man5/srec_brecord.5 b/doc/man5/srec_brecord.5 index 8de1ee6c..77ba4080 100644 --- a/doc/man5/srec_brecord.5 +++ b/doc/man5/srec_brecord.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_brecord .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_brecord \- Freescale MC68EZ328 Dragonball bootstrap record format .if require_index \{ .XX "srec_brecord(5)" "Freescale MC68EZ328 Dragonball bootstrap record format" .\} +.SH NAME +srec_brecord \- Freescale MC68EZ328 Dragonball bootstrap record format .\" ------------------------------------------------------------------------ .SH DESCRIPTION This data format is understood by Freescale MC68EZ328 Dragonball series diff --git a/doc/man5/srec_coe.5 b/doc/man5/srec_coe.5 index 9806cf18..dd55f6b0 100644 --- a/doc/man5/srec_coe.5 +++ b/doc/man5/srec_coe.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_coe .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_coe \- Xilinx Coefficient File Format .if require_index \{ .XX "srec_coe(5)" "Xilinx Coefficient File Format" .\} +.SH NAME +srec_coe \- Xilinx Coefficient File Format .SH DESCRIPTION The Xilinx Coefficient File Format has a general syntax of the form: diff --git a/doc/man5/srec_cosmac.5 b/doc/man5/srec_cosmac.5 index fa40099e..1300b46b 100644 --- a/doc/man5/srec_cosmac.5 +++ b/doc/man5/srec_cosmac.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_cosmac .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_cosmac \- RCA Cosmac Elf file format .if require_index \{ .XX "srec_cosmac(5)" "RCA Cosmac Elf file format" .\} +.SH NAME +srec_cosmac \- RCA Cosmac Elf file format .SH DESCRIPTION This file takes the form of one or more RCA Cosmac Elf monitor commands, also known as the IDIOT/4 monitor. diff --git a/doc/man5/srec_dec_binary.5 b/doc/man5/srec_dec_binary.5 index b5122285..b8587f17 100644 --- a/doc/man5/srec_dec_binary.5 +++ b/doc/man5/srec_dec_binary.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_dec_binary .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_dec_binary \- DEC Binary (XXDP) file format .if require_index \{ .XX "srec_dec_binary(5)" "DEC Binary (XXDP) file format" .\} +.SH NAME +srec_dec_binary \- DEC Binary (XXDP) file format .SH DESCRIPTION The DEC Binary (XXDP) format was used on the PDP 11 series machines. This is a binary format, and is not readable or editable with a text editor. diff --git a/doc/man5/srec_efinix.5 b/doc/man5/srec_efinix.5 index 4336db2f..5b7e07be 100644 --- a/doc/man5/srec_efinix.5 +++ b/doc/man5/srec_efinix.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_efinix .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_efinix \- Efinix bitstream file format .if require_index \{ .XX "srec_efinix(5)" "Efinix bitstream file format" .\} +.SH NAME +srec_efinix \- Efinix bitstream file format .SH DESCRIPTION This format is the Efinix bitstream file format and is also known as the \fIEfinix Hex\fP format. diff --git a/doc/man5/srec_emon52.5 b/doc/man5/srec_emon52.5 index e2cea39f..0bfe5acb 100644 --- a/doc/man5/srec_emon52.5 +++ b/doc/man5/srec_emon52.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_emon52 .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_emon52 \- Elektor Monitor (EMON52) file format .if require_index \{ .XX "srec_emon52(5)" "Elektor Monitor (EMON52) file format" .\} +.SH NAME +srec_emon52 \- Elektor Monitor (EMON52) file format .SH DESCRIPTION This format is used by the monitor EMON52, developed by the European electronics magazine Elektor (Elektuur in Holland). Elektor wouldn't diff --git a/doc/man5/srec_fairchild.5 b/doc/man5/srec_fairchild.5 index 3194ef72..471855bc 100644 --- a/doc/man5/srec_fairchild.5 +++ b/doc/man5/srec_fairchild.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_fairchild .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_fairchild \- Fairchild Fairbug file format .if require_index \{ .XX "srec_fairchild(5)" "Fairchild Fairbug file format" .\} +.SH NAME +srec_fairchild \- Fairchild Fairbug file format .SH DESCRIPTION The Fairchild Fairbug format has 8\[hy]byte records. A file begins with an address record and ends with an diff --git a/doc/man5/srec_fastload.5 b/doc/man5/srec_fastload.5 index 91c119a8..d1d83c87 100644 --- a/doc/man5/srec_fastload.5 +++ b/doc/man5/srec_fastload.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_fastload .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_fastload \- LSI Logic Fast Load file format .if require_index \{ .XX "srec_fastload(5)" "LSI Logic Fast Load file format" .\} +.SH NAME +srec_fastload \- LSI Logic Fast Load file format .SH DESCRIPTION The FastLoad Format uses a compressed ASCII format that permits files to be downloaded in less than half the time taken for Motorola S\[hy]records. diff --git a/doc/man5/srec_formatted_binary.5 b/doc/man5/srec_formatted_binary.5 index 4613fbde..573929ea 100644 --- a/doc/man5/srec_formatted_binary.5 +++ b/doc/man5/srec_formatted_binary.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_formatted_binary .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_formatted_binary \- Formatted Binary file format .if require_index \{ .XX "srec_formatted_binary(5)" "Formatted Binary file format" .\} +.SH NAME +srec_formatted_binary \- Formatted Binary file format .SH DESCRIPTION .\" ftp://ftp.dataio.com/main/Manuals/UniFam/Translation%20Formats.pdf This is the PDP\[hy]11 paper tape format, described in the diff --git a/doc/man5/srec_forth.5 b/doc/man5/srec_forth.5 index b40d5386..fa1b4096 100644 --- a/doc/man5/srec_forth.5 +++ b/doc/man5/srec_forth.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_forth .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_forth \- FORTH file format .if require_index \{ .XX "srec_forth(5)" "FORTH file format" .\} +.SH NAME +srec_forth \- FORTH file format .SH DESCRIPTION This format can be read by FORTH interpreters .PP diff --git a/doc/man5/srec_fpc.5 b/doc/man5/srec_fpc.5 index 7f91ad64..95ecccc8 100644 --- a/doc/man5/srec_fpc.5 +++ b/doc/man5/srec_fpc.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_fpc .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_fpc \- four packed code file format .if require_index \{ .XX "srec_fpc(5)" "Four Packed Code (FPC) file format" .\} +.SH NAME +srec_fpc \- four packed code file format .SH SYNOPSIS All ASCII based file formats have one disadvantage in common: they all need more than double the amount of characters as opposed to the number diff --git a/doc/man5/srec_hp64k.5 b/doc/man5/srec_hp64k.5 index dc317dc8..4959a0c6 100644 --- a/doc/man5/srec_hp64k.5 +++ b/doc/man5/srec_hp64k.5 @@ -20,11 +20,11 @@ .\" .ds n) srec_hp64k .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_hp64k \- HP64000 Absolute Data Format .if require_index \{ .XX "srec_hp64k(5)" "HP64000 Absolute Data Format" .\} +.SH NAME +srec_hp64k \- HP64000 Absolute Data Format .SH DESCRIPTION This format is the output of the HP 64000 Development System Linker and associated tools. All fields are 16-bit words. diff --git a/doc/man5/srec_idt.5 b/doc/man5/srec_idt.5 index e7f446b6..b8527ae9 100644 --- a/doc/man5/srec_idt.5 +++ b/doc/man5/srec_idt.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_idt .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_idt \- IDT/sim binary file format .if require_index \{ .XX "srec_idt(5)" "IDT/sim binary file format" .\} +.SH NAME +srec_idt \- IDT/sim binary file format .SH DESCRIPTION This format comes from Integrated Device Technology (IDT) System Integration Manager (IDT/sim). diff --git a/doc/man5/srec_intel.5 b/doc/man5/srec_intel.5 index 31897c23..9a62e8cc 100644 --- a/doc/man5/srec_intel.5 +++ b/doc/man5/srec_intel.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_intel .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_intel \- Intel Hexadecimal object file format specification .if require_index \{ .XX "srec_intel(5)" "Intel Hexadecimal object file format specification" .\} +.SH NAME +srec_intel \- Intel Hexadecimal object file format specification .SH DESCRIPTION This format is also known as the \fIIntel MCS\[hy]86 Object\fP format. .PP diff --git a/doc/man5/srec_intel16.5 b/doc/man5/srec_intel16.5 index eca9fb9d..62458ccf 100644 --- a/doc/man5/srec_intel16.5 +++ b/doc/man5/srec_intel16.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_intel16 .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_intel16 \- Intel Hexadecimal 16\[hy]bit file format specification .if require_index \{ -.XX "srec_intel16(5)" "Intel Hexadecimal 16\[hy]bit file format specification" +.XX "srec_intel16(5)" "Intel Hexadecimal 16-bit file format specification" .\} +.SH NAME +srec_intel16 \- Intel Hexadecimal 16\[hy]bit file format specification .SH DESCRIPTION This format is also known as the \fIINHX16\fP format. .PP diff --git a/doc/man5/srec_logisim.5 b/doc/man5/srec_logisim.5 index 5078dddc..b91a3d11 100644 --- a/doc/man5/srec_logisim.5 +++ b/doc/man5/srec_logisim.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_logisim .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_logisim \- format Logisim EPROM load files .if require_index \{ .XX "srec_logisim(5)" "format Logisim EPROM load files" .\} +.SH NAME +srec_logisim \- format Logisim EPROM load files .SH DESCRIPTION The file format used for image files is intentionally simple; this permits you to write a program, such as an assembler, that generates diff --git a/doc/man5/srec_mem.5 b/doc/man5/srec_mem.5 index e869c4e3..9f86a293 100644 --- a/doc/man5/srec_mem.5 +++ b/doc/man5/srec_mem.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_mem .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_mem \- Lattice Memory Initialization format .if require_index \{ .XX "srec_mem(5)" "Lattice Memory Initialization format" .\} +.SH NAME +srec_mem \- Lattice Memory Initialization format .SH DESCRIPTION A Lattice Memory Initialization format (.mem), by Lattice Semiconductor, file is an ASCII text file that consists of a header followed by lines diff --git a/doc/man5/srec_mif.5 b/doc/man5/srec_mif.5 index 11f7414f..e4544b44 100644 --- a/doc/man5/srec_mif.5 +++ b/doc/man5/srec_mif.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_mif .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_mif \- Memory Initialization File (MIF) format .if require_index \{ .XX "srec_mif(5)" "Memory Initialization File (MIF) format" .\} +.SH NAME +srec_mif \- Memory Initialization File (MIF) format .SH DESCRIPTION This format was invented by Altera. .PP diff --git a/doc/man5/srec_mips_flash.5 b/doc/man5/srec_mips_flash.5 index eb8780ae..7c192a0e 100644 --- a/doc/man5/srec_mips_flash.5 +++ b/doc/man5/srec_mips_flash.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_mips_flash .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_mips_flash \- MIPS\[hy]Flash file format .if require_index \{ .XX "srec_mips_flash(5)" "MIPS-Flash file format" .\} +.SH NAME +srec_mips_flash \- MIPS\[hy]Flash file format .SH DESCRIPTION The MIPS SDE tool chain has a \f[I]convert\fP program that is able to output this format. I have no idea what reads it, some kind of flash diff --git a/doc/man5/srec_mos_tech.5 b/doc/man5/srec_mos_tech.5 index 3b6b07e9..4b9d5d5f 100644 --- a/doc/man5/srec_mos_tech.5 +++ b/doc/man5/srec_mos_tech.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_mos_tech .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_mos_tech \- MOS Technology file format .if require_index \{ .XX "srec_mos_tech(5)" "MOS Technology file format" .\} +.SH NAME +srec_mos_tech \- MOS Technology file format .SH DESCRIPTION .\" ------------------------------------------------------------------------ The MOS Technology format allows binary files to be uploaded and diff --git a/doc/man5/srec_motorola.5 b/doc/man5/srec_motorola.5 index 68c36731..18ebd95c 100644 --- a/doc/man5/srec_motorola.5 +++ b/doc/man5/srec_motorola.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_motorola .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_motorola \- Motorola S\[hy]Record hexadecimal file format .if require_index \{ -.XX "srec_motorola(5)" "Motorola S\[hy]Record hexadecimal file format" +.XX "srec_motorola(5)" "Motorola S-Record hexadecimal file format" .\} +.SH NAME +srec_motorola \- Motorola S\[hy]Record hexadecimal file format .SH DESCRIPTION This format is also known as the \fIExorciser\fP, \fIExormacs\fP or \fIExormax\fP format. diff --git a/doc/man5/srec_msbin.5 b/doc/man5/srec_msbin.5 index 423f2565..e222d4ff 100644 --- a/doc/man5/srec_msbin.5 +++ b/doc/man5/srec_msbin.5 @@ -20,11 +20,11 @@ .\" .ds n) srec_msbin .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_msbin \- Windows CE Binary Image Data Format .if require_index \{ .XX "srec_msbin(5)" "Windows CE Binary Image Data Format" .\} +.SH NAME +srec_msbin \- Windows CE Binary Image Data Format .SH DESCRIPTION This format is the output of the Microsoft WinCE Platform Builder. This is a binary (non\[hy]text) file format. diff --git a/doc/man5/srec_needham.5 b/doc/man5/srec_needham.5 index 7816c2ab..708ab8e6 100644 --- a/doc/man5/srec_needham.5 +++ b/doc/man5/srec_needham.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_needham .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_needham \- Needham EMP\[hy]series programmer ASCII file format .if require_index \{ -.XX "srec_needham(5)" "Needham EMP\[hy]series programmer ASCII file format" +.XX "srec_needham(5)" "Needham EMP-series programmer ASCII file format" .\} +.SH NAME +srec_needham \- Needham EMP\[hy]series programmer ASCII file format .SH DESCRIPTION This format is understood by Needham Electronics' EMP\[hy]series programmers. See \f[CW]www.needhams.com/winman.pdf\fP for more information. diff --git a/doc/man5/srec_os65a.5 b/doc/man5/srec_os65a.5 index ed9953ec..958fea18 100644 --- a/doc/man5/srec_os65a.5 +++ b/doc/man5/srec_os65a.5 @@ -21,11 +21,11 @@ .\" .ds n) srec_os65a .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_os65a \- Ohio Scientific 65A monitor load format .if require_index \{ .XX "srec_os65a(5)" "Ohio Scientific 65A monitor load format" .\} +.SH NAME +srec_os65a \- Ohio Scientific 65A monitor load format .SH DESCRIPTION This format is used by the Ohio Scientific 65A monitor. This family of machines includes the Superboard II, C2, C4, C8, diff --git a/doc/man5/srec_os65v.5 b/doc/man5/srec_os65v.5 index cc022dd4..0449bfca 100644 --- a/doc/man5/srec_os65v.5 +++ b/doc/man5/srec_os65v.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_os65v .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_os65v \- OS65V Loader file format .if require_index \{ .XX "srec_os65v(5)" "OS65V Loader file format" .\} +.SH NAME +srec_os65v \- OS65V Loader file format .SH DESCRIPTION This format is used by Ohio Scientific OS65V\[hy]compatible loaders. This family of machines includes the OSI C1P, Superboard II, C2, C4, C8, diff --git a/doc/man5/srec_ppb.5 b/doc/man5/srec_ppb.5 index 546a07eb..677be56a 100644 --- a/doc/man5/srec_ppb.5 +++ b/doc/man5/srec_ppb.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_ppb .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_ppb \- Stag Prom Programmer binary format .if require_index \{ .XX "srec_ppb(5)" "Stag Prom Programmer binary format" .\} +.SH NAME +srec_ppb \- Stag Prom Programmer binary format .SH DESCRIPTION This is the native binary format of the Stag Prom Programmer. .SS Format diff --git a/doc/man5/srec_ppx.5 b/doc/man5/srec_ppx.5 index 6fd4f51b..3961f772 100644 --- a/doc/man5/srec_ppx.5 +++ b/doc/man5/srec_ppx.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_ppx .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_ppx \- Stag Prom Programmer hexadecimal format .if require_index \{ .XX "srec_ppx(5)" "Stag Prom Programmer hexadecimal format" .\} +.SH NAME +srec_ppx \- Stag Prom Programmer hexadecimal format .SH DESCRIPTION This is the native hexadecimal format of the Stag Prom Programmer. .SS Format diff --git a/doc/man5/srec_signetics.5 b/doc/man5/srec_signetics.5 index f8aeb9b5..0c702d37 100644 --- a/doc/man5/srec_signetics.5 +++ b/doc/man5/srec_signetics.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_signetics .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_signetics \- Signetics file format .if require_index \{ .XX "srec_signetics(5)" "Signetics file format" .\} +.SH NAME +srec_signetics \- Signetics file format .SH DESCRIPTION The Signetics file format is not often used. The major disadvantage in modern applications is that the addressing range is limited to only 64kb. diff --git a/doc/man5/srec_spasm.5 b/doc/man5/srec_spasm.5 index 3952cfeb..ffd8470f 100644 --- a/doc/man5/srec_spasm.5 +++ b/doc/man5/srec_spasm.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_spasm .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_spasm \- SPASM file format .if require_index \{ .XX "srec_spasm(5)" "SPASM file format" .\} +.SH NAME +srec_spasm \- SPASM file format .SH DESCRIPTION This format is the output of the Parallax SPASM assembler (now defunct, I'm told). diff --git a/doc/man5/srec_spectrum.5 b/doc/man5/srec_spectrum.5 index 7a42e3a1..ae4fd550 100644 --- a/doc/man5/srec_spectrum.5 +++ b/doc/man5/srec_spectrum.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_spectrum .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_spectrum \- Spectrum file format .if require_index \{ .XX "srec_spectrum(5)" "Spectrum file format" .\} +.SH NAME +srec_spectrum \- Spectrum file format .SH DESCRIPTION .\" ftp://ftp.dataio.com/main/Manuals/UniFam/Translation%20Formats.pdf In this format, bytes are recorded as ASCII code with binary digits diff --git a/doc/man5/srec_stewie.5 b/doc/man5/srec_stewie.5 index 7e23e6d3..e7973bc4 100644 --- a/doc/man5/srec_stewie.5 +++ b/doc/man5/srec_stewie.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_stewie .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_stewie \- Stewie's binary file format .if require_index \{ .XX "srec_stewie(5)" "Stewie's binary file format" .\} +.SH NAME +srec_stewie \- Stewie's binary file format .SH DESCRIPTION If you have a URL for documentation of this format, please let me know. .PP diff --git a/doc/man5/srec_tektronix.5 b/doc/man5/srec_tektronix.5 index 98b0c31a..3868b1b9 100644 --- a/doc/man5/srec_tektronix.5 +++ b/doc/man5/srec_tektronix.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_tektronix .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_tektronix \- Tektronix hexadecimal file format .if require_index \{ .XX "srec_tektronix(5)" "Tektronix hexadecimal file format" .\} +.SH NAME +srec_tektronix \- Tektronix hexadecimal file format .SH DESCRIPTION .\" ------------------------------------------------------------------------ The Tektronix hexadecimal file format is no longer very common. diff --git a/doc/man5/srec_tektronix_extended.5 b/doc/man5/srec_tektronix_extended.5 index 52b1011c..51d7b1e6 100644 --- a/doc/man5/srec_tektronix_extended.5 +++ b/doc/man5/srec_tektronix_extended.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_tektronix_extended .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_tektronix_extended \- Tektronix Extended hexadecimal file format .if require_index \{ .XX "srec_tektronix_extended(5)" "Tektronix Extended hexadecimal file format" .\} +.SH NAME +srec_tektronix_extended \- Tektronix Extended hexadecimal file format .SH DESCRIPTION .\" ------------------------------------------------------------------------ This format allows binary files to be uploaded and downloaded between diff --git a/doc/man5/srec_ti_tagged.5 b/doc/man5/srec_ti_tagged.5 index b3de4a15..62ef745b 100644 --- a/doc/man5/srec_ti_tagged.5 +++ b/doc/man5/srec_ti_tagged.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_ti_tagged .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_ti_tagged \- Texas Instruments Tagged (SDSMAC) file format .if require_index \{ .XX "srec_ti_tagged(5)" "Texas Instruments Tagged (SDSMAC) file format" .\} +.SH NAME +srec_ti_tagged \- Texas Instruments Tagged (SDSMAC) file format .SH DESCRIPTION This format is also known as the \f[I]TI\[hy]Tagged\fP or \f[I]TI\[hy]SDSMAC\fP format. diff --git a/doc/man5/srec_ti_tagged_16.5 b/doc/man5/srec_ti_tagged_16.5 index c106cdd2..1111930f 100644 --- a/doc/man5/srec_ti_tagged_16.5 +++ b/doc/man5/srec_ti_tagged_16.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_ti_tagged_16 .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_ti_tagged_16 \- Texas Instruments Tagged (SDSMAC 320) file format .if require_index \{ .XX "srec_ti_tagged_16(5)" "Texas Instruments Tagged (SDSMAC 320) file format" .\} +.SH NAME +srec_ti_tagged_16 \- Texas Instruments Tagged (SDSMAC 320) file format .SH DESCRIPTION This format is also known as the \f[I]TI\[hy]Tagged\fP or \f[I]Texas Instruments SDSMAC (320)\fP format. diff --git a/doc/man5/srec_ti_txt.5 b/doc/man5/srec_ti_txt.5 index 0e5ad840..606426a9 100644 --- a/doc/man5/srec_ti_txt.5 +++ b/doc/man5/srec_ti_txt.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_ti_txt .TH srec_ti_txt 5 SRecord "Reference Manual" -.SH NAME -srec_ti_txt \- Texas Instruments ti\[hy]txt (MSP430) file format .if require_index \{ -.XX "srec_ti_txt(5)" "Texas Instruments ti\[hy]txt (MSP430) file format" +.XX "srec_ti_txt(5)" "Texas Instruments ti-txt (MSP430) file format" .\} +.SH NAME +srec_ti_txt \- Texas Instruments ti\[hy]txt (MSP430) file format .SH DESCRIPTION The ti\[hy]TXT format is used by the Texas Instruments MSP430 family programming adapter. diff --git a/doc/man5/srec_trs80.5 b/doc/man5/srec_trs80.5 index 11190ba8..64c40820 100644 --- a/doc/man5/srec_trs80.5 +++ b/doc/man5/srec_trs80.5 @@ -20,11 +20,11 @@ .\" .ds n) srec_trs80 .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_trs80 \- Radio Shack TRS\[hy]80 object file format specification .if require_index \{ -.XX "srec_trs80(5)" "Radio Shack TRS\[hy]80 object file format specification" +.XX "srec_trs80(5)" "Radio Shack TRS-80 object file format specification" .\} +.SH NAME +srec_trs80 \- Radio Shack TRS\[hy]80 object file format specification .SH DESCRIPTION This document describes the binary object file format for the Z80\[hy]based Radio Shack TRS\[hy]80 microcomputers, such as the Model I, II, III, 4, 4D, diff --git a/doc/man5/srec_vhdl_textio.5 b/doc/man5/srec_vhdl_textio.5 index b0db4f03..e64379a0 100644 --- a/doc/man5/srec_vhdl_textio.5 +++ b/doc/man5/srec_vhdl_textio.5 @@ -17,11 +17,11 @@ .\" .ds n) srec_vhdl_textio .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_vhdl_textio \- file-format readable by vhdl textio.read functions. .if require_index \{ .XX "srec_vhdl_textio(5)" "VHDL textio readable format" .\} +.SH NAME +srec_vhdl_textio \- file-format readable by vhdl textio.read functions. .SH DESCRIPTION This format is used by VHDL IEEE Std 1076 tools implementing the textio package functions. They can be used in synthesis (to initialize memories) or diff --git a/doc/man5/srec_vmem.5 b/doc/man5/srec_vmem.5 index be3f95e7..ca9963bb 100644 --- a/doc/man5/srec_vmem.5 +++ b/doc/man5/srec_vmem.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_vmem .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_vmem \- vmem file format .if require_index \{ .XX "srec_vmem(5)" "VMEM file format" .\} +.SH NAME +srec_vmem \- vmem file format .SH DESCRIPTION This format is the Verilog VMEM format. This is a hex format suitable for loading into Verilog simulations using diff --git a/doc/man5/srec_wilson.5 b/doc/man5/srec_wilson.5 index 2f191036..d4c17385 100644 --- a/doc/man5/srec_wilson.5 +++ b/doc/man5/srec_wilson.5 @@ -18,11 +18,11 @@ .\" .ds n) srec_wilson .TH \*(n) 5 SRecord "Reference Manual" -.SH NAME -srec_wilson \- wilson file format .if require_index \{ .XX "srec_wilson(5)" "Wilson file format" .\} +.SH NAME +srec_wilson \- wilson file format .SH DESCRIPTION This is a mystery format, added to support a mystery EPROM loader used by Alan Wilson diff --git a/etc/template/man b/etc/template/man index fb332506..f413aaac 100644 --- a/etc/template/man +++ b/etc/template/man @@ -17,11 +17,11 @@ .\" .ds n) ${basename $fn .1} .TH \*(n) 1 SRecord "Reference Manual" -.SH NAME -\*(n) \- manipulate eprom load files .if require_index \{ .XX "${trim_ext ${basename $fn}}(1)" "manipulate eprom load files" .\} +.SH NAME +\*(n) \- manipulate eprom load files .SH SYNOPSIS .B \*(n) [