Skip to content

Commit bc89ff0

Browse files
committed
Re #2210 Provide further examples for arguments
1 parent bfc7183 commit bc89ff0

File tree

1 file changed

+51
-6
lines changed

1 file changed

+51
-6
lines changed

doc/commands/build_command.md

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -601,10 +601,19 @@ do not contain space or `"` characters) or quoted (`""`). Quoted arguments can
601601
include 'escaped' characters, escaped with an initial `\` character.
602602

603603
Account may need to be taken of the shell's approach to the processing of
604-
command line arguments. For example, to pass `'a single quoted string'`:
604+
command line arguments:
605605

606606
=== "Unix-like (Bash or Zsh)"
607607

608+
For example, to pass `word` and `words with spaces` in Bash, or Zsh:
609+
610+
`stack test --benchmark-arguments 'word "words with spaces"'`
611+
612+
The content of single quotes is taken literally, but cannot contain a single
613+
quote.
614+
615+
For example, to pass `'a single quoted string'`:
616+
608617
In Bash, or Zsh (if `RC_QUOTES` option not set):
609618

610619
`stack bench --benchmark-arguments \"\''a single quoted string'\'\"`
@@ -622,7 +631,13 @@ command line arguments. For example, to pass `'a single quoted string'`:
622631

623632
=== "Windows"
624633

625-
In PowerShell:
634+
For example, to pass `word` and `words with spaces` in PowerShell:
635+
636+
`stack test --benchmark-arguments 'word "words with spaces"'`
637+
638+
The content of single quotes is taken literally.
639+
640+
For example, to pass `'a single quoted string'` in PowerShell:
626641

627642
`stack bench --benchmark-arguments '"''a single quoted string''"'`
628643

@@ -644,10 +659,19 @@ do not contain space or `"` characters) or quoted (`""`). Quoted arguments can
644659
include 'escaped' characters, escaped with an initial `\` character.
645660

646661
Account may need to be taken of the shell's approach to the processing of
647-
command line arguments. For example, to pass `'a single quoted string'`:
662+
command line arguments:
648663

649664
=== "Unix-like (Bash or Zsh)"
650665

666+
For example, to pass `word` and `words with spaces` in Bash, or Zsh:
667+
668+
`stack build --exec '<command> word "words with spaces"'`
669+
670+
The content of single quotes is taken literally, but cannot contain a single
671+
quote.
672+
673+
For example, to pass `'a single quoted string'`:
674+
651675
In Bash, or Zsh (if `RC_QUOTES` option not set):
652676

653677
`stack build --exec '<command> '\"\''a single quoted string'\'\"`
@@ -665,7 +689,13 @@ command line arguments. For example, to pass `'a single quoted string'`:
665689

666690
=== "Windows"
667691

668-
In PowerShell:
692+
For example, to pass `word` and `words with spaces` in PowerShell:
693+
694+
`stack build --exec '<command> word "words with spaces"'`
695+
696+
The content of single quotes is taken literally.
697+
698+
For example, to pass `'a single quoted string'` in PowerShell:
669699

670700
`stack build --exec '<command> "''a single quoted string''"'`
671701

@@ -702,10 +732,19 @@ do not contain space or `"` characters) or quoted (`""`). Quoted arguments can
702732
include 'escaped' characters, escaped with an initial `\` character.
703733

704734
Account may need to be taken of the shell's approach to the processing of
705-
command line arguments. For example, to pass `'a single quoted string'`:
735+
command line arguments:
706736

707737
=== "Unix-like (Bash or Zsh)"
708738

739+
For example, to pass `word` and `words with spaces` in Bash, or Zsh:
740+
741+
`stack test --test-arguments 'word "words with spaces"'`
742+
743+
The content of single quotes is taken literally, but cannot contain a single
744+
quote.
745+
746+
For example, to pass `'a single quoted string'`:
747+
709748
In Bash, or Zsh (if `RC_QUOTES` option not set):
710749

711750
`stack test --test-arguments \"\''a single quoted string'\'\"`
@@ -723,7 +762,13 @@ command line arguments. For example, to pass `'a single quoted string'`:
723762

724763
=== "Windows"
725764

726-
In PowerShell:
765+
For example, to pass `word` and `words with spaces` in PowerShell:
766+
767+
`stack test --test-arguments 'word "words with spaces"'`
768+
769+
The content of single quotes is taken literally.
770+
771+
For example, to pass `'a single quoted string'` in PowerShell:
727772

728773
`stack test --test-arguments '"''a single quoted string''"'`
729774

0 commit comments

Comments
 (0)