diff options
author | dgp <dgp@users.sourceforge.net> | 2020-03-31 15:59:35 (GMT) |
---|---|---|
committer | dgp <dgp@users.sourceforge.net> | 2020-03-31 15:59:35 (GMT) |
commit | dfcc6b3a0ed4b8f7f5c9022957b039e10dbc98b4 (patch) | |
tree | 5a55e33913589ab5afe6a5aa78cb48cba08a964e /doc | |
parent | 4258dcc3acd1ffc9d3dec78cb9eef89ace9ac7f5 (diff) | |
parent | 7240c45f5734d0b14fe6b80d43c27093eb04d11e (diff) | |
download | tcl-dfcc6b3a0ed4b8f7f5c9022957b039e10dbc98b4.zip tcl-dfcc6b3a0ed4b8f7f5c9022957b039e10dbc98b4.tar.gz tcl-dfcc6b3a0ed4b8f7f5c9022957b039e10dbc98b4.tar.bz2 |
[b8e82d293b] Restrict the options of [binary encode uuencode] to values that
will not prevent ability of [binary decode uuencode] to decode the result.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/binary.n | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/binary.n b/doc/binary.n index 1f93c03..92a939a 100644 --- a/doc/binary.n +++ b/doc/binary.n @@ -110,23 +110,27 @@ produce files that other implementations of decoders cannot process): .TP \fB\-maxlen \fIlength\fR . -Indicates that the output should be split into lines of no more than -\fIlength\fR characters. By default, lines are split every 61 characters, and -this must be in the range 3 to 85 due to limitations in the encoding. +Indicates the maximum number of characters to produce for each encoded line. +The valid range is 5 to 85. Line lengths outside that range cannot be +accommodated by the encoding format. The default value is 61. .TP \fB\-wrapchar \fIcharacter\fR . -Indicates that, when lines are split because of the \fB\-maxlen\fR option, -\fIcharacter\fR should be used to separate lines. By default, this is a -newline character, -.QW \en . +Indicates the character(s) to use to mark the end of each encoded line. +Acceptable values are a sequence of zero or more characters from the +set { \\x09 (TAB), \\x0B (VT), \\x0C (FF), \\x0D (CR) } followed +by zero or one newline \\x0A (LF). Any other values are rejected because +they would generate encoded text that could not be decoded. The default value +is a single newline. .PP During decoding, the following options are supported: .TP \fB\-strict\fR . -Instructs the decoder to throw an error if it encounters unexpected -whitespace characters. Otherwise it ignores them. +Instructs the decoder to throw an error if it encounters anything +outside of the standard encoding format. Without this option, the +decoder tolerates some deviations, mostly to forgive reflows of lines +between the encoder and decoder. .PP Note that neither the encoder nor the decoder handle the header and footer of the uuencode format. |