Skip to content

Commit a0a8253

Browse files
committed
format(docs): remove escaped 's character pairs
1 parent 93e24b5 commit a0a8253

Some content is hidden

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

80 files changed

+385
-385
lines changed

docs/bash4.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The `read` builtin command has some interesting new features.
7777
The `-t` option to specify a timeout value has been slightly tuned. It
7878
now accepts fractional values and the special value 0 (zero). When
7979
`-t 0` is specified, `read` immediately returns with an exit status
80-
indicating if there\'s data waiting or not. However, when a timeout is
80+
indicating if there's data waiting or not. However, when a timeout is
8181
given, and the `read` builtin times out, any partial data recieved up to
8282
the timeout is stored in the given variable, rather than lost. When a
8383
timeout is hit, `read` exits with a code greater than 128.

docs/commands/builtin/caller.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ f3
5959

6060
## Notes
6161

62-
- `caller` produces no output unless used within a script that\'s run
62+
- `caller` produces no output unless used within a script that's run
6363
from a real file. It isn\'t particularly useful for interactive use,
6464
but can be used to create a decent `die` function to track down
6565
errors in moderately complex scripts.
@@ -68,7 +68,7 @@ f3
6868
are available and a number of special parameters that give more
6969
detail than caller (e.g. BASH_ARG{C,V}). Tools such as
7070
[Bashdb](http://bashdb.sourceforge.net/) can assist in using some of
71-
Bash\'s more advanced debug features.
71+
Bash's more advanced debug features.
7272
- The Bash manpage and help text specifies that the argument to
7373
`caller` is an \"expr\" (whatever that means). Only an integer is
7474
actually allowed, with no special interpretation of an

docs/commands/builtin/cd.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `cd` builtin command is used to change the current working directory
1313
- to the given directory (`cd DIRECTORY`)
1414
- to the previous working directory (`cd -`) as saved in the
1515
[OLDPWD](../../syntax/shellvars.md#OLDPWD) shell variable
16-
- to the user\'s home directory as specified in the
16+
- to the user's home directory as specified in the
1717
[HOME](../../syntax/shellvars.md#HOME) environment variable (when used
1818
without a `DIRECTORY` argument)
1919

@@ -30,7 +30,7 @@ is given or the shell is configured to do so (see the `-P` option of
3030
-------- ----------------------------------------------------
3131
`-L` Follow symbolic links (default)
3232
`-P` Do not follow symbolic links
33-
`-@` Browse a file\'s extended attributed, if supported
33+
`-@` Browse a file's extended attributed, if supported
3434

3535
### Exit status
3636

@@ -41,7 +41,7 @@ is given or the shell is configured to do so (see the `-P` option of
4141

4242
## Examples
4343

44-
### Change the working directory to the user\'s home directory
44+
### Change the working directory to the user's home directory
4545

4646
cd
4747

docs/commands/builtin/declare.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ variable.
2222
When used in a function, `declare` makes `NAMEs` local variables, unless
2323
used with the `-g` option.
2424

25-
Don\'t use it\'s synonym `typeset` when coding for Bash, since it\'s
25+
Don\'t use it's synonym `typeset` when coding for Bash, since it's
2626
tagged as obsolete.
2727

2828
### Options
@@ -52,7 +52,7 @@ Below, `[-+]X` indicates an attribute, use `-X` to set the attribute,
5252
`[-+]n` make NAME a reference to the variable named by its value. Introduced in Bash 4.3-alpha.\
5353
\'\' \${!NAME}\'\' reveals the reference variable name, VALUE.\
5454
Use `unset -n NAME` to unset the variable. (`unset -v NAME` unsets the VALUE variable.)\
55-
Use `[[ -R NAME ]]` to test if NAME has been set to a VALUE, another variable\'s name.
55+
Use `[[ -R NAME ]]` to test if NAME has been set to a VALUE, another variable's name.
5656

5757
`-p` display the attributes and value of each NAME
5858

@@ -156,9 +156,9 @@ a=(1 2 3); b=(6 5 4); c=(2 4 6) sum total a b c printf \'Final value of
156156
\"total\" is: %d\\n\' \"\$total\" \</div\>
157157

158158
`typeset -n` is currently implemented in ksh93, mksh, and Bash 4.3. Bash
159-
and mksh\'s implementations are quite similar, but much different from
160-
ksh93\'s. See [Portability considerations](#portability_considerations)
161-
for details. ksh93 namerefs are much more powerful than Bash\'s.
159+
and mksh's implementations are quite similar, but much different from
160+
ksh93's. See [Portability considerations](#portability_considerations)
161+
for details. ksh93 namerefs are much more powerful than Bash's.
162162

163163
## Portability considerations
164164

docs/commands/builtin/echo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Description
88

9-
`echo` outputs it\'s args to stdout, separated by spaces, followed by a
9+
`echo` outputs it's args to stdout, separated by spaces, followed by a
1010
newline. The return status is always `0`. If the
1111
[shopt](../../commands/builtin/shopt.md) option `xpg_echo` is set, Bash
1212
dynamically determines whether echo should expand escape characters

docs/commands/builtin/eval.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ identical to those of [let](../../commands/builtin/let.md).
168168
eval](http://mywiki.wooledge.org/BashFAQ/006#Assigning_indirect.2BAC8-reference_variables)
169169
- [More indirection via
170170
eval](http://fvue.nl/wiki/Bash:_Passing_variables_by_reference)
171-
- [Martin Väth\'s \"push\"](https://github.com/vaeth/push) \--
171+
- [Martin Väth's \"push\"](https://github.com/vaeth/push) \--
172172
`printf %q` work-alike for POSIX.
173173
- [The \"magic alias\"
174174
hack](http://www.chiark.greenend.org.uk/~sgtatham/aliases.html)

docs/commands/builtin/let.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ command](../../syntax/ccmd/arithmetic_eval.md):
4444
\<WRAP info\> Remember that inside arithmetic evaluation contexts, all
4545
other expansions are processed as usual (from left-to-right), and the
4646
resulting text is evaluated as an arithmetic expression. Arithmetic
47-
already has a way to control precedence using parentheses, so it\'s very
48-
rare to need to nest arithmetic expansions within one another. It\'s
47+
already has a way to control precedence using parentheses, so it's very
48+
rare to need to nest arithmetic expansions within one another. It's
4949
used above only to illustrate how this precedence works. \</WRAP\>
5050

5151
Unlike `((`, being a simple command `let` has its own environment. In
@@ -87,10 +87,10 @@ needed.
8787
is more \"standard\" than `let`, the above should always be
8888
preferred. Both [arithmetic expansion](../../syntax/arith_expr.md)s and the
8989
`[` test operator are specified by POSIX(r) and satisfy almost all
90-
of expr\'s use-cases. Unlike `let`, `expr` cannot assign directly to
90+
of expr's use-cases. Unlike `let`, `expr` cannot assign directly to
9191
bash variables but instead returns a result on stdout. `expr` takes
9292
each operator it recognizes as a separate word and then concatenates
93-
them into a single expression that\'s evaluated according to it\'s
93+
them into a single expression that's evaluated according to it's
9494
own rules (which differ from shell arithmetic). `let` parses each
9595
word it recieves on its own and evaluates it as an expression
9696
without generating any output other than a return code.

docs/commands/builtin/local.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ way, and takes all the same options, with 3 exceptions:
4848
variables follow roughly
4949
[lexical-scoping](http://community.schemewiki.org/?lexical-scope),
5050
except that functions themselves don\'t have scope, just like Bash.
51-
This means that even functions defined within a \"function\'s
51+
This means that even functions defined within a \"function's
5252
scope\" don\'t have access to non-local variables except through
5353
`namerefs`.
5454

docs/commands/builtin/mapfile.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ given array `ARRAY` is set readonly.
2929
`-t` Remove any trailing newline from a line read, before it is assigned to an array element.
3030
`-u FD` Read from filedescriptor `FD` rather than standard input.
3131

32-
While `mapfile` isn\'t a common or portable shell feature, it\'s
32+
While `mapfile` isn\'t a common or portable shell feature, it's
3333
functionality will be familiar to many programmers. Almost all
3434
programming languages (aside from shells) with support for compound
3535
datatypes like arrays, and which handle open file objects in the
@@ -43,13 +43,13 @@ use.
4343

4444
## Examples
4545

46-
Here\'s a real-world example of interactive use borrowed from Gentoo
46+
Here's a real-world example of interactive use borrowed from Gentoo
4747
workflow. Xorg updates require rebuilding drivers, and the
48-
Gentoo-suggested command is less than ideal, so let\'s Bashify it. The
48+
Gentoo-suggested command is less than ideal, so let's Bashify it. The
4949
first command produces a list of packages, one per line. We can read
5050
those into the array named \"args\" using `mapfile`, stripping trailing
5151
newlines with the \'-t\' option. The resulting array is then expanded
52-
into the arguments of the \"emerge\" command - an interface to Gentoo\'s
52+
into the arguments of the \"emerge\" command - an interface to Gentoo's
5353
package manager. This type of usage can make for a safe and effective
5454
replacement for xargs(1) in certain situations. Unlike xargs, all
5555
arguments are guaranteed to be passed to a single invocation of the
@@ -59,13 +59,13 @@ business.
5959
# eix --only-names -IC x11-drivers | { mapfile -t args; emerge -av1 "${args[@]}" <&1; }
6060

6161
Note the use of command grouping to keep the emerge command inside the
62-
pipe\'s subshell and within the scope of \"args\". Also note the unusual
62+
pipe's subshell and within the scope of \"args\". Also note the unusual
6363
redirection. This is because the -a flag makes emerge interactive,
6464
asking the user for confirmation before continuing, and checking with
6565
isatty(3) to abort if stdin isn\'t pointed at a terminal. Since stdin of
6666
the entire command group is still coming from the pipe even though
6767
mapfile has read all available input, we just borrow FD 1 as it just so
68-
happens to be pointing where we want it. More on this over at greycat\'s
68+
happens to be pointing where we want it. More on this over at greycat's
6969
wiki: <http://mywiki.wooledge.org/BashFAQ/024>
7070

7171
### The callback
@@ -209,7 +209,7 @@ each subsequent 2 iterations. The RETURN trap is unimportant.
209209

210210
## To Do
211211

212-
- Create an implementation as a shell function that\'s portable
212+
- Create an implementation as a shell function that's portable
213213
between Ksh, Zsh, and Bash (and possibly other bourne-like shells
214214
with array support).
215215

@@ -218,4 +218,4 @@ each subsequent 2 iterations. The RETURN trap is unimportant.
218218
- [arrays](../../syntax/arrays.md)
219219
- [read](../../commands/builtin/read.md) - If you don\'t know about this yet,
220220
why are you reading this page?
221-
- <http://mywiki.wooledge.org/BashFAQ/001> - It\'s FAQ 1 for a reason.
221+
- <http://mywiki.wooledge.org/BashFAQ/001> - It's FAQ 1 for a reason.

docs/commands/builtin/printf.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ POSIX(r) recommends that `printf` is preferred over `echo`.
2323
## General
2424

2525
The `printf` command provides a method to print preformatted text
26-
similar to the `printf()` system interface (C function). It\'s meant as
26+
similar to the `printf()` system interface (C function). It's meant as
2727
successor for `echo` and has far more features and possibilities.
2828

2929
Beside other reasons, POSIX(r) has a very good argument to recommend it:
@@ -164,7 +164,7 @@ introductory `%` and the character that specifies the format:
164164

165165
Field output format
166166
--------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
167-
`<N>` **Any number**: Specifies a **minimum field width**, if the text to print is shorter, it\'s padded with spaces, if the text is longer, the field is expanded
167+
`<N>` **Any number**: Specifies a **minimum field width**, if the text to print is shorter, it's padded with spaces, if the text is longer, the field is expanded
168168
`.` **The dot**: Together with a field width, the field is **not** expanded when the text is longer, the text is truncated instead. \"`%.s`\" is an undocumented equivalent for \"`%.0s`\", which will force a field width of zero, effectively hiding the field from output
169169
`*` **The asterisk**: the width is given as argument before the string or number. Usage (the \"`*`\" corresponds to the \"`20`\"): `printf "%*s\n" 20 "test string"`
170170
`#` \"Alternative format\" for numbers: see table below
@@ -178,8 +178,8 @@ introductory `%` and the character that specifies the format:
178178

179179
Alternative Format
180180
-------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------
181-
`%#o` The octal number is printed with a leading zero, unless it\'s zero itself
182-
`%#x`, `%#X` The hex number is printed with a leading \"`0x`\"/\"`0X`\", unless it\'s zero
181+
`%#o` The octal number is printed with a leading zero, unless it's zero itself
182+
`%#x`, `%#X` The hex number is printed with a leading \"`0x`\"/\"`0X`\", unless it's zero
183183
`%#g`, `%#G` The float number is printed with **trailing zeros** until the number of digits for the current precision is reached (usually trailing zeros are not printed)
184184
all number formats except `%d`, `%o`, `%x`, `%X` Always print a decimal point in the output, even if no digits follow it
185185

@@ -382,7 +382,7 @@ readability.
382382
use `%c`, you\'re actually asking for the first byte of the
383383
argument. Likewise, the maximum field width modifier (dot) in
384384
combination with `%s` goes by bytes, not characters. This limits
385-
some of printf\'s functionality to working with ascii only. ksh93\'s
385+
some of printf's functionality to working with ascii only. ksh93's
386386
`printf` supports the `L` modifier with `%s` and `%c` (but so far
387387
not `%S` or `%C`) in order to treat precision as character width,
388388
not byte count. zsh appears to adjust itself dynamically based upon
@@ -409,7 +409,7 @@ fmt++;
409409
- mksh has no built-in printf by default (usually). There is an
410410
unsupported compile-time option to include a very poor, basically
411411
unusable implementation. For the most part you must rely upon the
412-
system\'s `/usr/bin/printf` or equivalent. The mksh maintainer
412+
system's `/usr/bin/printf` or equivalent. The mksh maintainer
413413
recommends using `print`. The development version (post- R40f) adds
414414
a new parameter expansion in the form of `${name@Q}` which fills the
415415
role of `printf %q` \-- expanding in a shell-escaped format.
@@ -418,7 +418,7 @@ fmt++;
418418
<!-- -->
419419
```
420420
- ksh93 optimizes builtins run from within a command substitution and
421-
which have no redirections to run in the shell\'s process. Therefore
421+
which have no redirections to run in the shell's process. Therefore
422422
the `printf -v` functionality can be closely matched by
423423
`var=$(printf ...)` without a big performance hit.
424424

@@ -447,8 +447,8 @@ fmt++;
447447

448448
- The optional Bash loadable `print` may be useful for ksh
449449
compatibility and to overcome some of
450-
[echo](../../commands/builtin/echo.md)\'s portability pitfalls. Bash, ksh93,
451-
and zsh\'s `print` have an `-f` option which takes a `printf` format
450+
[echo](../../commands/builtin/echo.md)'s portability pitfalls. Bash, ksh93,
451+
and zsh's `print` have an `-f` option which takes a `printf` format
452452
string and applies it to the remaining arguments. Bash lists the
453453
synopsis as:
454454
`print: print [-Rnprs] [-u unit] [-f format] [arguments]`. However,
@@ -472,5 +472,5 @@ fmt++;
472472
function](http://pubs.opengroup.org/onlinepubs/9699919799/functions/printf.html)
473473
- [Code snip: Print a horizontal
474474
line](../../snipplets/print_horizontal_line.md) uses some `printf` examples
475-
- [Greg\'s BashFAQ 18: How can I use numbers with leading zeros in a
475+
- [Greg's BashFAQ 18: How can I use numbers with leading zeros in a
476476
loop, e.g., 01, 02?](BashFAQ>018)

docs/commands/builtin/read.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ line is read). That means the timeout can occur during input, too.
4343
---------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
4444
`-a <ARRAY>` read the data word-wise into the specified array `<ARRAY>` instead of normal variables
4545
`-d <DELIM>` recognize `<DELIM>` as data-end, rather than `<newline>`
46-
`-e` on interactive shells: use Bash\'s readline interface to read the data. Since version 5.1-alpha, this can also be used on specified file descriptors using `-u`
46+
`-e` on interactive shells: use Bash's readline interface to read the data. Since version 5.1-alpha, this can also be used on specified file descriptors using `-u`
4747
`-i <STRING>` preloads the input buffer with text from `<STRING>`, only works when Readline (`-e`) is used
4848
`-n <NCHARS>` reads `<NCHARS>` characters of input, then quits
4949
`-N <NCHARS>` reads `<NCHARS>` characters of input, *ignoring any delimiter*, then quits
@@ -56,7 +56,7 @@ line is read). That means the timeout can occur during input, too.
5656
When both, `-a <ARRAY>` and a variable name `<NAME>` is given, then the
5757
array is set, but not the variable.
5858

59-
Of course it\'s valid to set individual array elements without using
59+
Of course it's valid to set individual array elements without using
6060
`-a`:
6161

6262
read MYARRAY[5]
@@ -99,7 +99,7 @@ array name and index:
9999
Essentially all you need to know about `-r` is to **ALWAYS** use it. The
100100
exact behavior you get without `-r` is completely useless even for weird
101101
purposes. It basically allows the escaping of input which matches
102-
something in IFS, and also escapes line continuations. It\'s explained
102+
something in IFS, and also escapes line continuations. It's explained
103103
pretty well in the [POSIX
104104
read](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/read.html#tag_20_109)
105105
spec.
@@ -141,7 +141,7 @@ some baskslash-escapes or switches (like `-n`).
141141

142142
### Press any key\...
143143

144-
Remember the MSDOS `pause` command? Here\'s something similar:
144+
Remember the MSDOS `pause` command? Here's something similar:
145145

146146
pause() {
147147
local dummy

docs/commands/builtin/shift.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ maintainer refuses to change either the `shift` or `command` builtins.~~
7777
[Fixed](https://github.com/MirBSD/mksh/commit/996e05548ab82f7ef2dea61f109cc7b6d13837fa).
7878
(Thanks!)
7979

80-
- Perhaps almost as bad as the above, busybox sh\'s `shift` always
80+
- Perhaps almost as bad as the above, busybox sh's `shift` always
8181
returns success, even when attempting to shift beyond the final
8282
argument. \<code\> \$ bb -c \'f() { if shift; then echo \"\$1\";
8383
else echo \"no args\"; fi; }; f\'

docs/commands/builtin/trap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Special events
3434
`EXIT` 0 executed on shell exit
3535
`DEBUG` executed before every simple command
3636
`RETURN` executed when a shell function or a sourced code finishes executing
37-
`ERR` executed each time a command\'s failure would cause the shell to exit when the [`-e` option (`errexit`)](../../commands/builtin/set.md) is enabled
37+
`ERR` executed each time a command's failure would cause the shell to exit when the [`-e` option (`errexit`)](../../commands/builtin/set.md) is enabled
3838

3939
### Options
4040

0 commit comments

Comments
 (0)