Skip to content

Commit

Permalink
conventions: latest doc-kit changes (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
taroth21 authored and tahliar committed Jan 8, 2024
1 parent 3e74605 commit bea2949
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions xml/common_intro_convention_ha.xml
Original file line number Diff line number Diff line change
Expand Up @@ -84,20 +84,37 @@
A cross-reference to another chapter in this guide.
</para>
</listitem>
<listitem>
<listitem>
<para>
Commands that must be run with &rootuser; privileges. Often you can also
Commands that must be run with &rootuser; privileges. You can also
prefix these commands with the <command>sudo</command> command to run them
as non-privileged user.
as a non-privileged user:
</para>
<screen>&prompt.root;<command>command</command>
&prompt.sudo;<command>command</command></screen>
</listitem>
<listitem>
<para>
Commands that can be run by non-privileged users.
Commands that can be run by non-privileged users:
</para>
<screen>&prompt.user;<command>command</command></screen>
</listitem>
<listitem>
<para>
Commands can be split into two or multiple lines by a backslash character
(<literal>\</literal>) at the end of a line. The backslash informs the shell that
the command invocation will continue after the line's end:
</para>
<screen>&prompt.user;<command>echo</command> a b \
c d</screen>
</listitem>
<listitem>
<para>
A code block that shows both the command (preceded by a prompt)
and the respective output returned by the shell:
</para>
<screen>&prompt.user;<command>command</command>
output</screen>
</listitem>
<listitem>
<para>
Expand Down

0 comments on commit bea2949

Please sign in to comment.