From 4472fecc92ccf8ec327a8047080a1b9f80b1ac44 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Thu, 25 Apr 2024 02:23:04 -0400 Subject: blob2xex: tweak doc. --- blob2xex.1 | 21 +++++++++++++-------- blob2xex.rst | 21 +++++++++++++-------- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/blob2xex.1 b/blob2xex.1 index b53beb3..41cd28c 100644 --- a/blob2xex.1 +++ b/blob2xex.1 @@ -58,7 +58,10 @@ output. \fBblob2xex\fP will not write output to a terminal; \fB\-\fP must be used with redirection or a pipe. .sp If \fIoutfile\fP or any \fIinfile\fP is a filename that begins with a \fB\-\fP, -prefix it with "./", otherwise it\(aqll be taken as an option. +prefix it with "./", otherwise it\(aqll be taken as an option. The GNU +style \fB\-\-\fP (end of options) isn\(aqt implemented because it doesn\(aqt +make sense here. How often do you really use \fB\-\fP at the start of a +filename, anyway? .sp Addresses, offsets, and sizes may be given in decimal or hex. Hex addresses must be prefixed with either \fB$\fP or \fB0x\fP\&. @@ -69,21 +72,23 @@ not \fB\-l0x2000\fP\&. .INDENT 0.0 .TP .B \-r \fIrunaddr\fP -Optional; set the run address. Since a .xex file can only have one -run address, there\(aqs no point in giving multiple \fB\-r\fP options. If -you do, the last one will be used. This option should be first on -the command line (right after \fIoutfile\fP), or at least must occur -before any \fIinfile\fP\&. +Optional; set the run address. Default is no run address. Since a +\&.xex file can only have one run address, there\(aqs no point in giving +multiple \fB\-r\fP options. If you do, the last one will be used. This +option should be first on the command line (right after \fIoutfile\fP), +or at least must occur before any \fIinfile\fP\&. .TP .B \-l \fIloadaddr\fP -Set the load address of the next \fIinfile\fP\&. Each \fIinfile\fP must be preceded by -a \fB\-l\fP option. +Required; set the load address of the next \fIinfile\fP\&. Each \fIinfile\fP +\fBmust\fP be preceded by a \fB\-l\fP option. .TP .B \-i \fIinitaddr\fP Optional; set an init address, to be executed after the next segment loads. +Default is no init address. .TP .B \-o \fIoffset\fP Optional; skip this many bytes of the next input file. Default is \fB0\fP\&. +See the \fBComplex Example\fP below. .TP .B \-s \fIsize\fP Optional; read this many bytes of the next input file. Default is the entire file, diff --git a/blob2xex.rst b/blob2xex.rst index 9699c2b..af6a220 100644 --- a/blob2xex.rst +++ b/blob2xex.rst @@ -38,7 +38,10 @@ output. **blob2xex** will not write output to a terminal; **-** must be used with redirection or a pipe. If *outfile* or any *infile* is a filename that begins with a **-**, -prefix it with "./", otherwise it'll be taken as an option. +prefix it with "./", otherwise it'll be taken as an option. The GNU +style **--** (end of options) isn't implemented because it doesn't +make sense here. How often do you really use **-** at the start of a +filename, anyway? Addresses, offsets, and sizes may be given in decimal or hex. Hex addresses must be prefixed with either **$** or **0x**. @@ -50,21 +53,23 @@ A space is required between an option and its argument; use e.g. **-l 0x2000**, not **-l0x2000**. -r *runaddr* - Optional; set the run address. Since a .xex file can only have one - run address, there's no point in giving multiple **-r** options. If - you do, the last one will be used. This option should be first on - the command line (right after *outfile*), or at least must occur - before any *infile*. + Optional; set the run address. Default is no run address. Since a + .xex file can only have one run address, there's no point in giving + multiple **-r** options. If you do, the last one will be used. This + option should be first on the command line (right after *outfile*), + or at least must occur before any *infile*. -l *loadaddr* - Set the load address of the next *infile*. Each *infile* must be preceded by - a **-l** option. + Required; set the load address of the next *infile*. Each *infile* + **must** be preceded by a **-l** option. -i *initaddr* Optional; set an init address, to be executed after the next segment loads. + Default is no init address. -o *offset* Optional; skip this many bytes of the next input file. Default is **0**. + See the **Complex Example** below. -s *size* Optional; read this many bytes of the next input file. Default is the entire file, -- cgit v1.2.3