]> xenbits.xensource.com Git - libvirt.git/commitdiff
formatsecret.html.in: Kill useless spaces in <pre/>
authorMichal Privoznik <mprivozn@redhat.com>
Fri, 11 Nov 2016 22:40:27 +0000 (23:40 +0100)
committerMichal Privoznik <mprivozn@redhat.com>
Mon, 14 Nov 2016 10:03:34 +0000 (11:03 +0100)
The <pre/> section is rendered as-is on the page. That is, if all
the lines are prefixed with 4 spaces the rendered page will also
have them. Problem is if we put a box around such <pre/> because
the content might not fix into it.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
docs/formatsecret.html.in

index e4bf50f9e729b43c36bfeb6dac1fbdeb710f00a2..21b93397c82bae46e66bb855bdbb0df5ea0df55a 100644 (file)
     </p>
 
     <pre>
-      &lt;secret ephemeral='no' private='yes'&gt;
-         &lt;description&gt;Super secret name of my first puppy&lt;/description&gt;
-         &lt;uuid&gt;0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f&lt;/uuid&gt;
-         &lt;usage type='volume'&gt;
-            &lt;volume&gt;/var/lib/libvirt/images/puppyname.img&lt;/volume&gt;
-         &lt;/usage&gt;
-      &lt;/secret&gt;
+&lt;secret ephemeral='no' private='yes'&gt;
+   &lt;description&gt;Super secret name of my first puppy&lt;/description&gt;
+   &lt;uuid&gt;0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f&lt;/uuid&gt;
+   &lt;usage type='volume'&gt;
+      &lt;volume&gt;/var/lib/libvirt/images/puppyname.img&lt;/volume&gt;
+   &lt;/usage&gt;
+&lt;/secret&gt;
     </pre>
 
     <p>
       Define the secret and set the passphrase as follows:
     </p>
     <pre>
-      # virsh secret-define volume-secret.xml
-      Secret 0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f created
-      #
-      # MYSECRET=`printf %s "open sesame" | base64`
-      # virsh secret-set-value 0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f $MYSECRET
-      Secret value set
-      #
+# virsh secret-define volume-secret.xml
+Secret 0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f created
+#
+# MYSECRET=`printf %s "open sesame" | base64`
+# virsh secret-set-value 0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f $MYSECRET
+Secret value set
+#
     </pre>
 
     <p>
@@ -88,9 +88,9 @@
       volume <a href="formatstorageencryption.html">encryption</a> as follows:
     </p>
     <pre>
-      &lt;encryption format='qcow'&gt;
-        &lt;secret type='passphrase' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/&gt;
-      &lt;/encryption&gt;
+&lt;encryption format='qcow'&gt;
+  &lt;secret type='passphrase' uuid='0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f'/&gt;
+&lt;/encryption&gt;
     </pre>
 
     <p>
       <span class="since">since 2.1.0</span>. An example follows:
     </p>
     <pre>
-      # cat luks-secret.xml
-      &lt;secret ephemeral='no' private='yes'&gt;
-         &lt;description&gt;LUKS Sample Secret&lt;/description&gt;
-         &lt;uuid&gt;f52a81b2-424e-490c-823d-6bd4235bc57&lt;/uuid&gt;
-         &lt;usage type='volume'&gt;
-            &lt;volume&gt;/var/lib/libvirt/images/luks-sample.img&lt;/volume&gt;
-         &lt;/usage&gt;
-      &lt;/secret&gt;
-
-      # virsh secret-define luks-secret.xml
-      Secret f52a81b2-424e-490c-823d-6bd4235bc57 created
-      #
-      # MYSECRET=`printf %s "letmein" | base64`
-      # virsh secret-set-value f52a81b2-424e-490c-823d-6bd4235bc57 $MYSECRET
-      Secret value set
-      #
+# cat luks-secret.xml
+&lt;secret ephemeral='no' private='yes'&gt;
+   &lt;description&gt;LUKS Sample Secret&lt;/description&gt;
+   &lt;uuid&gt;f52a81b2-424e-490c-823d-6bd4235bc57&lt;/uuid&gt;
+   &lt;usage type='volume'&gt;
+      &lt;volume&gt;/var/lib/libvirt/images/luks-sample.img&lt;/volume&gt;
+   &lt;/usage&gt;
+&lt;/secret&gt;
+
+# virsh secret-define luks-secret.xml
+Secret f52a81b2-424e-490c-823d-6bd4235bc57 created
+#
+# MYSECRET=`printf %s "letmein" | base64`
+# virsh secret-set-value f52a81b2-424e-490c-823d-6bd4235bc57 $MYSECRET
+Secret value set
+#
     </pre>
 
     <h3><a name="CephUsageType">Usage type "ceph"</a></h3>
     </p>
 
     <pre>
-      &lt;secret ephemeral='no' private='yes'&gt;
-         &lt;description&gt;CEPH passphrase example&lt;/description&gt;
-         &lt;usage type='ceph'&gt;
-            &lt;name&gt;ceph_example&lt;/name&gt;
-         &lt;/usage&gt;
-      &lt;/secret&gt;
+&lt;secret ephemeral='no' private='yes'&gt;
+   &lt;description&gt;CEPH passphrase example&lt;/description&gt;
+   &lt;usage type='ceph'&gt;
+      &lt;name&gt;ceph_example&lt;/name&gt;
+   &lt;/usage&gt;
+&lt;/secret&gt;
     </pre>
 
     <p>
       chosen secret pass phrase.
     </p>
     <pre>
-      # virsh secret-define ceph-secret.xml
-      Secret 1b40a534-8301-45d5-b1aa-11894ebb1735 created
-      #
-      # virsh secret-list
      UUID                                 Usage
-      -----------------------------------------------------------
      1b40a534-8301-45d5-b1aa-11894ebb1735 cephx ceph_example
-      #
-      # CEPHPHRASE=`printf %s "pass phrase" | base64`
-      # virsh secret-set-value 1b40a534-8301-45d5-b1aa-11894ebb1735 $CEPHPHRASE
-      Secret value set
-
-      #
+# virsh secret-define ceph-secret.xml
+Secret 1b40a534-8301-45d5-b1aa-11894ebb1735 created
+#
+# virsh secret-list
+ UUID                                 Usage
+-----------------------------------------------------------
+ 1b40a534-8301-45d5-b1aa-11894ebb1735 cephx ceph_example
+#
+# CEPHPHRASE=`printf %s "pass phrase" | base64`
+# virsh secret-set-value 1b40a534-8301-45d5-b1aa-11894ebb1735 $CEPHPHRASE
+Secret value set
+
+#
     </pre>
 
     <p>
       element as follows:
     </p>
     <pre>
-      &lt;auth username='myname'&gt;
-        &lt;secret type='ceph' usage='ceph_example'/&gt;
-      &lt;/auth&gt;
+&lt;auth username='myname'&gt;
+  &lt;secret type='ceph' usage='ceph_example'/&gt;
+&lt;/auth&gt;
     </pre>
 
     <p>
       <code>&lt;source&gt;</code> element as follows:
     </p>
     <pre>
-      &lt;auth type='ceph' username='myname'&gt;
-        &lt;secret usage='ceph_example'/&gt;
-      &lt;/auth&gt;
+&lt;auth type='ceph' username='myname'&gt;
+  &lt;secret usage='ceph_example'/&gt;
+&lt;/auth&gt;
     </pre>
 
     <h3><a name="iSCSIUsageType">Usage type "iscsi"</a></h3>
       authentication file:
     </p>
       <pre>
-      &lt;target iqn.2013-07.com.example:iscsi-pool&gt;
-      backing-store /home/tgtd/iscsi-pool/disk1
-      backing-store /home/tgtd/iscsi-pool/disk2
-      incominguser myname mysecret
-      &lt;/target&gt;
+&lt;target iqn.2013-07.com.example:iscsi-pool&gt;
+backing-store /home/tgtd/iscsi-pool/disk1
+backing-store /home/tgtd/iscsi-pool/disk2
+incominguser myname mysecret
+&lt;/target&gt;
       </pre>
     <p>
       Define an iscsi-secret.xml file to describe the secret. Use the
       or disk XML description.
     </p>
     <pre>
-      &lt;secret ephemeral='no' private='yes'&gt;
-         &lt;description&gt;Passphrase for the iSCSI example.com server&lt;/description&gt;
-         &lt;usage type='iscsi'&gt;
-            &lt;target&gt;libvirtiscsi&lt;/target&gt;
-         &lt;/usage&gt;
-      &lt;/secret&gt;
+&lt;secret ephemeral='no' private='yes'&gt;
+   &lt;description&gt;Passphrase for the iSCSI example.com server&lt;/description&gt;
+   &lt;usage type='iscsi'&gt;
+      &lt;target&gt;libvirtiscsi&lt;/target&gt;
+   &lt;/usage&gt;
+&lt;/secret&gt;
     </pre>
 
     <p>
       used in the iSCSI authentication configuration file.
     </p>
     <pre>
-      # virsh secret-define secret.xml
-      Secret c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 created
-
-      # virsh secret-list
      UUID                                 Usage
-      -----------------------------------------------------------
      c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 iscsi libvirtiscsi
-
-      # MYSECRET=`printf %s "mysecret" | base64`
-      # virsh secret-set-value c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 $MYSECRET
-      Secret value set
-      #
+# virsh secret-define secret.xml
+Secret c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 created
+
+# virsh secret-list
+ UUID                                 Usage
+-----------------------------------------------------------
+ c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 iscsi libvirtiscsi
+
+# MYSECRET=`printf %s "mysecret" | base64`
+# virsh secret-set-value c4dbe20b-b1a3-4ac1-b6e6-2ac97852ebb6 $MYSECRET
+Secret value set
+#
     </pre>
 
     <p>
       element as follows:
     </p>
     <pre>
-      &lt;auth username='myname'&gt;
-        &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
-      &lt;/auth&gt;
+&lt;auth username='myname'&gt;
+  &lt;secret type='iscsi' usage='libvirtiscsi'/&gt;
+&lt;/auth&gt;
     </pre>
 
     <p>
       <code>&lt;source&gt;</code> element as follows:
     </p>
     <pre>
-      &lt;auth type='chap' username='myname'&gt;
-        &lt;secret usage='libvirtiscsi'/&gt;
-      &lt;/auth&gt;
+&lt;auth type='chap' username='myname'&gt;
+  &lt;secret usage='libvirtiscsi'/&gt;
+&lt;/auth&gt;
     </pre>
 
     <h3><a name="tlsUsageType">Usage type "tls"</a></h3>
     </p>
 
     <pre>
-      # cat tls-secret.xml
-      &lt;secret ephemeral='no' private='yes'&gt;
-         &lt;description&gt;sample tls secret&lt;/description&gt;
-         &lt;usage type='tls'&gt;
-            &lt;name&gt;TLS_example&lt;/name&gt;
-         &lt;/usage&gt;
-      &lt;/secret&gt;
-
-      # virsh secret-define tls-secret.xml
-      Secret 718c71bd-67b5-4a2b-87ec-a24e8ca200dc created
-
-      # virsh secret-list
      UUID                                 Usage
-      -----------------------------------------------------------
      718c71bd-67b5-4a2b-87ec-a24e8ca200dc  tls TLS_example
-      #
+# cat tls-secret.xml
+&lt;secret ephemeral='no' private='yes'&gt;
+   &lt;description&gt;sample tls secret&lt;/description&gt;
+   &lt;usage type='tls'&gt;
+      &lt;name&gt;TLS_example&lt;/name&gt;
+   &lt;/usage&gt;
+&lt;/secret&gt;
+
+# virsh secret-define tls-secret.xml
+Secret 718c71bd-67b5-4a2b-87ec-a24e8ca200dc created
+
+# virsh secret-list
+ UUID                                 Usage
+-----------------------------------------------------------
+ 718c71bd-67b5-4a2b-87ec-a24e8ca200dc  tls TLS_example
+#
 
     </pre>
 
     </p>
 
     <pre>
-      # MYSECRET=`printf %s "letmein" | base64`
-      # virsh secret-set-value 718c71bd-67b5-4a2b-87ec-a24e8ca200dc $MYSECRET
-      Secret value set
+# MYSECRET=`printf %s "letmein" | base64`
+# virsh secret-set-value 718c71bd-67b5-4a2b-87ec-a24e8ca200dc $MYSECRET
+Secret value set
 
     </pre>