mirrors/wordsplit
1
0
Fork 0
mirror of git://git.gnu.org.ua/wordsplit.git synced 2025-04-26 00:29:54 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve docs

Browse source
This commit is contained in:
Sergey Poznyakoff 2019-07-10 09:54:32 +03:00
parent 5742ab5a03
commit d36275fe9a
2 changed files with 48 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

14
wordsplit.3
View file

@ -333,7 +333,7 @@ The \fBWRDSF_ESCAPE\fR flag allows the caller to customize escape
sequences. If it is set, the \fBws_escape\fR member must be
initialized. This member provides escape tables for unquoted words
(\fBws_escape[0]\fR) and quoted strings (\fBws_escape[1]\fR). Each
table is a string consisting of an even number of charactes. In each
table is a string consisting of an even number of characters. In each
pair of characters, the first one is a character that can appear after
backslash, and the following one is its translation. For example, the
above table of C escapes is represented as
@ -600,10 +600,10 @@ flag must be set. By default, it's value is \fB\(dq#\(dq\fR.
Escape tables for unquoted words (\fBws_escape[0]\fR) and quoted
strings (\fBws_escape[1]\fR). These are used to translate escape
sequences (\fB\\\fIC\fR) into characters. Each table is a string
consisting of even number of charactes. In each pair of characters,
consisting of even number of characters. In each pair of characters,
the first one is a character that can appear after backslash, and the
following one is its representation. For example, the string
\fB\(dqt\\tn\\n\(dq\fR translates \fB\\t\fR into horisontal
\fB\(dqt\\tn\\n\(dq\fR translates \fB\\t\fR into horizontal
tabulation character and \fB\\n\fR into newline.
.B WRDSF_ESCAPE
flag must be set if this member is initialized.
@ -755,8 +755,8 @@ Default flags. This is a shortcut for:
WRDSF_SQUEEZE_DELIMS |\
WRDSF_CESCAPES)\fR,
i.e.: disable variable expansion and quote substituton, perform quote
removal, treat any number of consequtive delimiters as a single
i.e.: disable variable expansion and quote substitution, perform quote
removal, treat any number of consecutive delimiters as a single
delimiter, replace \fBC\fR escapes appearing in the input string with
the corresponding characters.
.TP
@ -807,7 +807,7 @@ flag is set, and error code is returned. If this flag is set, the
function is called instead. This function is not supposed to return.
.TP
.B WRDSF_WS
Trim off any leading and trailind whitespace from the returned
Trim off any leading and trailing whitespace from the returned
words. This flag is useful if the \fIws_delim\fR member does not
contain whitespace characters.
.TP
@ -1007,7 +1007,7 @@ Undefined variable. This error is returned only if the
\fBWRDSF_UNDEF\fR flag is set.
.TP
.B WRDSE_NOINPUT
Input exhausted. This is not acually an error. This code is returned
Input exhausted. This is not actually an error. This code is returned
if \fBwordsplit\fR (or \fBwordsplit_len\fR) is invoked in incremental
mode and encounters end of input string. See the section
.BR "INCREMENTAL MODE" .