Skip to content

Commit f208c19

Browse files
author
daobrien
committed
Address #186 Missing line continuation prompts.
1 parent f090483 commit f208c19

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

en-US/Design.xml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,22 +249,23 @@ $ vi myFile.txt
249249

250250
</example>
251251
<para>
252-
If the commands are long, complex, or wrap over multiple lines, use the following design to help optimize clarity, and to make it easy for users to copy and paste the command if required:
252+
If the commands are long, complex, or wrap over multiple lines, use the following design to help optimize clarity.
253+
If you are documenting commands on a different operating system, update the prompts and line continuation characters to suit.
253254
</para>
254255
<example>
255256
<title>Documenting Long Commands</title>
256257

257258
<screen># tar --selinux -czvf config_files.tar.gz /etc/katello \
258-
/etc/elasticsearch /etc/candlepin /etc/pulp /etc/gofer \
259-
/etc/grinder /etc/pki/katello /etc/pki/pulp /etc/qpidd.conf \
260-
/etc/sysconfig/katello /etc/sysconfig/elasticsearch \
261-
/root/ssl–build /var/www/html/pub/* /var/lib/katello
259+
> /etc/elasticsearch /etc/candlepin /etc/pulp /etc/gofer \
260+
> /etc/grinder /etc/pki/katello /etc/pki/pulp /etc/qpidd.conf \
261+
> /etc/sysconfig/katello /etc/sysconfig/elasticsearch \
262+
> /root/ssl–build /var/www/html/pub/* /var/lib/katello
262263

263264
# cd /var/lib/katello
264265

265266
# myCommand --option funky --color=true \
266-
--config_file=&lt;replaceable&gt;/home/user/config.conf&lt;/replaceable&gt; \
267-
--output_file=&lt;replaceable&gt;/home/user/output.txt&lt;/replaceable&gt;</screen>
267+
> --config_file=&lt;replaceable&gt;/home/user/config.conf&lt;/replaceable&gt; \
268+
> --output_file=&lt;replaceable&gt;/home/user/output.txt&lt;/replaceable&gt;</screen>
268269

269270
</example>
270271

0 commit comments

Comments
 (0)