Skip to content

Commit f3e5061

Browse files
marcowsmarcows
committed
doc: Move .XX macros up a few lines before .SH macros
Only in doc/man1/srec_license.1 there is no .SH macro, so put it below .TH (which in most cases is placed directly before .SH anyway). Preparation for extending the .XX macro to also generate PDF outline entries additionally to the TOC entries. To get the link target at the correct position. This change also has the effect to remove the probably unintended empty line at each place where this ".if require_index \{ .XX ... .\}" construct was used, in most cases after the NAME section. The TOC itself is unchanged in principle, merely line numbers have changed because of reduced number of pages (due to removed empty lines).
1 parent 70dc28c commit f3e5061

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+113
-113
lines changed

‎doc/etc/BUILDING.man

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
.if n .hy 0
2121
.if n .ad l
2222
.if n .nr IN 8n
23+
.XX "" "How to build SRecord"
2324
.SH NAME
2425
How to build SRecord
25-
.XX "" "How to build SRecord"
2626
.SH SPACE REQUIREMENTS
2727
You will need about 3MB to unpack and build the
2828
.I SRecord

‎doc/etc/README.man

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
.so etc/version.so
2020
.hy 0
2121
.ad l
22+
.XX "" "The README file"
2223
.SH NAME
2324
SRecord \- manipulate EPROM load files
24-
.XX "" "The README file"
2525
.SH DESCRIPTION
2626
The \f[I]SRecord\fP package is a collection of powerful tools for
2727
manipulating EPROM load files.
@@ -421,8 +421,8 @@ Peter Miller;E\[hy]Mail:;[email protected]
421421
.TE
422422
.br
423423
.bp
424-
.SH RELEASE NOTES
425424
.XX "" "Release Notes"
425+
.SH RELEASE NOTES
426426
This section details the various features and bug fixes of the various
427427
releases. For excruciating and complete detail, and also credits for
428428
those of you who have generously sent me suggestions and bug reports,

‎doc/etc/new-file-format.so

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
.\" <http://www.gnu.org/licenses/>.
1818
.\"
1919
.TH "New Format" "SRecord" "SRecord" "Reference Manual"
20+
.XX "" "How to add a new file format"
2021
.SH NAME
2122
How to add a new file format
22-
.XX "" "How to add a new file format"
2323
.SH DESCRIPTION
2424
This section describes how to add a new file format. It's mostly a
2525
set of reminders for the maintainer. If you want a format added to

‎doc/etc/new-filter.so

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
.\" <http://www.gnu.org/licenses/>.
1818
.\"
1919
.TH "New Filter" "SRecord" "SRecord" "Reference Manual"
20+
.XX "" "How to add a new filter"
2021
.SH NAME
2122
How to add a new filter
22-
.XX "" "How to add a new filter"
2323
.SH DESCRIPTION
2424
This section describes how to add a new filter. It's mostly a set
2525
of reminders for the maintainer. If you want a filter added to the

‎doc/man1/srec_cat.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_cat
2020
.TH \*(n) 1 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_cat \- manipulate EPROM load files
2321
.if require_index \{
2422
.XX "srec_cat(1)" "Manipulate EPROM load files"
2523
.\}
24+
.SH NAME
25+
srec_cat \- manipulate EPROM load files
2626
.SH SYNOPSIS
2727
.B \*(n)
2828
[

‎doc/man1/srec_cmp.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srec_cmp
1919
.TH \*(n) 1 SRecord "Reference Manual"
20-
.SH NAME
21-
srec_cmp \- compare two EPROM load files for equality
2220
.if require_index \{
2321
.XX "srec_cmp(1)" "Compare two EPROM load files for equality"
2422
.\}
23+
.SH NAME
24+
srec_cmp \- compare two EPROM load files for equality
2525
.SH SYNOPSIS
2626
.B \*(n)
2727
[

‎doc/man1/srec_examples.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srec_cat
1919
.TH srec_examples 1 SRecord "Reference Manual"i
20-
.SH NAME
21-
srec_examples \- examples of how to use SRecord
2220
.if require_index \{
2321
.XX "srec_examples(1)" "Examples of how to use SRecord"
2422
.\}
23+
.SH NAME
24+
srec_examples \- examples of how to use SRecord
2525
.SH DESCRIPTION
2626
The \f[I]srec_cat\fP command is very powerful, due to the ability to combine
2727
the the input filters in almost unlimited ways.

‎doc/man1/srec_info.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_info
2020
.TH \*(n) 1 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_info \- information about EPROM load files
2321
.if require_index \{
2422
.XX "srec_info(1)" "Information about EPROM load files"
2523
.\}
24+
.SH NAME
25+
srec_info \- information about EPROM load files
2626
.SH SYNOPSIS
2727
.B \*(n)
2828
[

‎doc/man1/srec_input.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srec_input
1919
.TH \*(n) 1 SRecord "Reference Manual"
20-
.SH NAME
21-
\*(n) \- input file specifications
2220
.if require_index \{
2321
.XX "srec_input(1)" "Input file specifications"
2422
.\}
23+
.SH NAME
24+
\*(n) \- input file specifications
2525
.SH SYNOPSIS
2626
\f[B]srec_*\fP \f[I]filename\fP [ \f[I]format\fP ]
2727
.SH DESCRIPTION

‎doc/man1/srec_license.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.TH GPL GNU GPL GNU "Free Software Foundation"
2+
.if require_index \{
3+
.XX "srec_license(1)" "GNU General Public License"
4+
.\}
25
.PP
36
.ce 2
47
GNU GENERAL PUBLIC LICENSE
58
Version 3, 29 June 2007
6-
.if require_index \{
7-
.XX "srec_license(1)" "GNU General Public License"
8-
.\}
99
.PP
1010
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
1111
Everyone is permitted to copy and distribute verbatim copies

‎doc/man3/srecord.3

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srecord
1919
.TH \*(n) 3 SRecord "Reference Manual"
20-
.SH NAME
21-
srecord \- library to manipulate EPROM load files
2220
.if require_index \{
2321
.XX "srecord(3)" "Library to manipulate EPROM load files"
2422
.\}
23+
.SH NAME
24+
srecord \- library to manipulate EPROM load files
2525
.SH SYNOPSIS
2626
#include <srecord/\f[I]name\fP.h>
2727
.sp

‎doc/man3/srecord_license.3

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
.TH LGPL 3 LGPL GNU "Free Software Foundation"
2+
.if require_index \{
3+
.XX "srecord_license(3)" "GNU Lesser General Public License"
4+
.\}
25
.SH NAME
36
LGPG \- GNU Lesser General Public License
47
.SH DESCRIPTION
58
.PP
69
.ce 2
710
GNU LESSER GENERAL PUBLIC LICENSE
811
Version 3, 29 June 2007
9-
.if require_index \{
10-
.XX "srecord_license(3)" "GNU Lesser General Public License"
11-
.\}
1212
.PP
1313
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
1414
.br

‎doc/man5/srec_aomf.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_aomf
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_aomf \- Intel Absolute Object Module Format
2321
.if require_index \{
2422
.XX "srec_aomf(5)" "Intel Absolute Object Module Format"
2523
.\}
24+
.SH NAME
25+
srec_aomf \- Intel Absolute Object Module Format
2626
.SH DESCRIPTION
2727
The Absolute Object Module Format (AOMF) is a subset of the 8051 OMF.
2828
The structure of an absolute object file (the order of the records in

‎doc/man5/srec_ascii_hex.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_ascii_hex
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_ascii_hex \- Ascii\[hy]Hex file format
2321
.if require_index \{
2422
.XX "srec_ascii_hex(5)" "Ascii\[hy]Hex file format"
2523
.\}
24+
.SH NAME
25+
srec_ascii_hex \- Ascii\[hy]Hex file format
2626
.SH DESCRIPTION
2727
This format is also known as the \fIAscii\[hy]Space\[hy]Hex\fP or
2828
\fIAscii\[hy]Hex\[hy]Space\fP format.

‎doc/man5/srec_atmel_generic.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_atmel_generic
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_atmel_generic \- Atmel Generic file format
2321
.if require_index \{
2422
.XX "srec_atmel_generic(5)" "Atmel Generic file format"
2523
.\}
24+
.SH NAME
25+
srec_atmel_generic \- Atmel Generic file format
2626
.SH DESCRIPTION
2727
This format is the output of the Atmel AVR assembler.
2828
The file contains two columns of hexadecimal coded values.

‎doc/man5/srec_binary.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srec_binary
1919
.TH srec_binary 5 SRecord "Reference Manual"
20-
.SH NAME
21-
srec_binary \- binary file format
2220
.if require_index \{
2321
.XX "srec_binary(5)" "Binary file format"
2422
.\}
23+
.SH NAME
24+
srec_binary \- binary file format
2525
.SH DESCRIPTION
2626
It is possible to read and write binary files using \f[I]srec_cat\fP(1).
2727
.SS File Holes

‎doc/man5/srec_brecord.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_brecord
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_brecord \- Freescale MC68EZ328 Dragonball bootstrap record format
2321
.if require_index \{
2422
.XX "srec_brecord(5)" "Freescale MC68EZ328 Dragonball bootstrap record format"
2523
.\}
24+
.SH NAME
25+
srec_brecord \- Freescale MC68EZ328 Dragonball bootstrap record format
2626
.\" ------------------------------------------------------------------------
2727
.SH DESCRIPTION
2828
This data format is understood by Freescale MC68EZ328 Dragonball series

‎doc/man5/srec_coe.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
.\"
1818
.ds n) srec_coe
1919
.TH \*(n) 5 SRecord "Reference Manual"
20-
.SH NAME
21-
srec_coe \- Xilinx Coefficient File Format
2220
.if require_index \{
2321
.XX "srec_coe(5)" "Xilinx Coefficient File Format"
2422
.\}
23+
.SH NAME
24+
srec_coe \- Xilinx Coefficient File Format
2525
.SH DESCRIPTION
2626
The Xilinx Coefficient File Format
2727
has a general syntax of the form:

‎doc/man5/srec_cosmac.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_cosmac
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_cosmac \- RCA Cosmac Elf file format
2321
.if require_index \{
2422
.XX "srec_cosmac(5)" "RCA Cosmac Elf file format"
2523
.\}
24+
.SH NAME
25+
srec_cosmac \- RCA Cosmac Elf file format
2626
.SH DESCRIPTION
2727
This file takes the form of one or more RCA Cosmac Elf monitor commands,
2828
also known as the IDIOT/4 monitor.

‎doc/man5/srec_dec_binary.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_dec_binary
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_dec_binary \- DEC Binary (XXDP) file format
2321
.if require_index \{
2422
.XX "srec_dec_binary(5)" "DEC Binary (XXDP) file format"
2523
.\}
24+
.SH NAME
25+
srec_dec_binary \- DEC Binary (XXDP) file format
2626
.SH DESCRIPTION
2727
The DEC Binary (XXDP) format was used on the PDP 11 series machines.
2828
This is a binary format, and is not readable or editable with a text editor.

‎doc/man5/srec_efinix.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_efinix
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_efinix \- Efinix bitstream file format
2321
.if require_index \{
2422
.XX "srec_efinix(5)" "Efinix bitstream file format"
2523
.\}
24+
.SH NAME
25+
srec_efinix \- Efinix bitstream file format
2626
.SH DESCRIPTION
2727
This format is the Efinix bitstream file format and is also known as the
2828
\fIEfinix Hex\fP format.

‎doc/man5/srec_emon52.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_emon52
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_emon52 \- Elektor Monitor (EMON52) file format
2321
.if require_index \{
2422
.XX "srec_emon52(5)" "Elektor Monitor (EMON52) file format"
2523
.\}
24+
.SH NAME
25+
srec_emon52 \- Elektor Monitor (EMON52) file format
2626
.SH DESCRIPTION
2727
This format is used by the monitor EMON52, developed by the European
2828
electronics magazine Elektor (Elektuur in Holland). Elektor wouldn't

‎doc/man5/srec_fairchild.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_fairchild
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_fairchild \- Fairchild Fairbug file format
2321
.if require_index \{
2422
.XX "srec_fairchild(5)" "Fairchild Fairbug file format"
2523
.\}
24+
.SH NAME
25+
srec_fairchild \- Fairchild Fairbug file format
2626
.SH DESCRIPTION
2727
The Fairchild Fairbug format has 8\[hy]byte records.
2828
A file begins with an address record and ends with an

‎doc/man5/srec_fastload.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_fastload
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_fastload \- LSI Logic Fast Load file format
2321
.if require_index \{
2422
.XX "srec_fastload(5)" "LSI Logic Fast Load file format"
2523
.\}
24+
.SH NAME
25+
srec_fastload \- LSI Logic Fast Load file format
2626
.SH DESCRIPTION
2727
The FastLoad Format uses a compressed ASCII format that permits files
2828
to be downloaded in less than half the time taken for Motorola S\[hy]records.

‎doc/man5/srec_formatted_binary.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_formatted_binary
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_formatted_binary \- Formatted Binary file format
2321
.if require_index \{
2422
.XX "srec_formatted_binary(5)" "Formatted Binary file format"
2523
.\}
24+
.SH NAME
25+
srec_formatted_binary \- Formatted Binary file format
2626
.SH DESCRIPTION
2727
.\" ftp://ftp.dataio.com/main/Manuals/UniFam/Translation%20Formats.pdf
2828
This is the PDP\[hy]11 paper tape format, described in the

‎doc/man5/srec_forth.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_forth
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_forth \- FORTH file format
2321
.if require_index \{
2422
.XX "srec_forth(5)" "FORTH file format"
2523
.\}
24+
.SH NAME
25+
srec_forth \- FORTH file format
2626
.SH DESCRIPTION
2727
This format can be read by FORTH interpreters
2828
.PP

‎doc/man5/srec_fpc.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
.\"
1919
.ds n) srec_fpc
2020
.TH \*(n) 5 SRecord "Reference Manual"
21-
.SH NAME
22-
srec_fpc \- four packed code file format
2321
.if require_index \{
2422
.XX "srec_fpc(5)" "Four Packed Code (FPC) file format"
2523
.\}
24+
.SH NAME
25+
srec_fpc \- four packed code file format
2626
.SH SYNOPSIS
2727
All ASCII based file formats have one disadvantage in common: they all
2828
need more than double the amount of characters as opposed to the number

‎doc/man5/srec_hp64k.5

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@
2020
.\"
2121
.ds n) srec_hp64k
2222
.TH \*(n) 5 SRecord "Reference Manual"
23-
.SH NAME
24-
srec_hp64k \- HP64000 Absolute Data Format
2523
.if require_index \{
2624
.XX "srec_hp64k(5)" "HP64000 Absolute Data Format"
2725
.\}
26+
.SH NAME
27+
srec_hp64k \- HP64000 Absolute Data Format
2828
.SH DESCRIPTION
2929
This format is the output of the HP 64000 Development System Linker and
3030
associated tools. All fields are 16-bit words.

0 commit comments

Comments
 (0)