Skip to content

Commit 0c182df

Browse files
authored
Line continuation for multiple operating systems (#548)
* Line continuation for multiple operating systems * Minor edit
1 parent a353d5e commit 0c182df

File tree

1 file changed

+25
-29
lines changed

1 file changed

+25
-29
lines changed

en-US/Design.xml

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,21 @@ $ vi myFile.txt
425425
<para>
426426
Use line continuation characters without the associated PS2 prompts.
427427
</para>
428+
</listitem>
429+
<listitem>
430+
<para>
431+
On Linux and macOS operating systems, use the Linux shell continuation character (\).
432+
</para>
433+
</listitem>
434+
<listitem>
435+
<para>
436+
On Windows operating systems, use the backtick character (`).
437+
</para>
438+
</listitem>
439+
<listitem>
440+
<para>
441+
For content that is potentially used in multiple operating systems, use the Linux shell continuation character, and include an explanatory sentence before the command.
442+
</para>
428443
</listitem>
429444
</itemizedlist>
430445
<!-- <important>
@@ -438,39 +453,20 @@ $ vi myFile.txt
438453
<!-- You can use this option for any of these designs. -->
439454
</para>
440455

441-
<!-- <example><title>Wrapping Long Commands with Continuation Characters and PS2 Prompts</title>
456+
<example><title>Long Command Example</title>
442457
<para>
443-
This example uses both continuation characters and PS2 prompts.
444-
</para>
445-
446-
<screen># tar &#45;&#45;selinux -czvf config_files.tar.gz /etc/katello \
447-
> /etc/elasticsearch /etc/candlepin /etc/pulp /etc/gofer \
448-
> /etc/grinder /etc/pki/katello /etc/pki/pulp /etc/qpidd.conf \
449-
> /etc/sysconfig/katello /etc/sysconfig/elasticsearch \
450-
> /root/ssl-build /var/www/html/pub/* /var/lib/katello</screen>
451-
</example>
452-
453-
<example><title>Wrapping Long Commands Without Continuation Characters or PS2 Prompts</title>
458+
If the <systemitem>memory</systemitem> machine pool does not exist, then create it.
459+
</para>
454460
<para>
455-
This example uses neither continuation characters nor PS2 prompts, but it does show how to use line indentation to help to clarify long commands.
461+
On a Microsoft Windows system, replace the line continuation character (\) in the following long command with the backtick character (`), which is the line continuation character in PowerShell.
456462
</para>
457-
<screen># cd /var/lib/katello
458-
459-
# myCommand &#45;&#45;option funky &#45;&#45;color=true
460-
&#45;&#45;config_file=/home/user/config.conf
461-
&#45;&#45;output_file=/home/user/output.txt</screen>
462-
463-
</example> -->
464-
465-
<example><title>Wrapping Long Commands with Continuation Characters and Without PS2 Prompts</title>
463+
<screen>$ <userinput>aws iam create-policy --policy-name RosaCloudWatch \ </userinput>
464+
<userinput> --policy-document file://policy.json --query Policy.Arn --output text</userinput>
465+
arn:aws:iam::452954386616:policy/RosaCloudWatch
466+
</screen>
466467
<para>
467-
This example uses continuation characters but not PS2 prompts.
468-
</para>
469-
<screen>[root@node]# cephadm bootstrap --mon-ip=MON_IP --registry-url=registry.redhat.io \
470-
--registry-username=REGISTRY_USERNAME --registry-password=REGISTRY_PASSWORD \
471-
--initial-dashboard-password=DASHBOARD_PASSWORD --dashboard-password-noupdate \
472-
--allow-fqdn-hostname</screen>
473-
468+
The ARN in the preceding output is different on your system.
469+
</para>
474470
</example>
475471

476472
</section>

0 commit comments

Comments
 (0)