Browse files

Commiting our first manpages.

  • Loading branch information...
1 parent 0817d46 commit 07ab18ddfb03a6b32de41b591b6d6aebd4659d61 @Mattsface Mattsface committed Dec 30, 2012
View
69 docs/en/man/man1/xe-pif-param-clear.ad
@@ -0,0 +1,69 @@
+XE(1)
+=======
+:doctype: manpage
+:man source: xe
+:man version: {1}
+:man manual: xe pif-param-clear manual
+
+NAME
+----
+xe-pif-param-clear - Clears a specific writable parameter for a PIF.
+
+SYNOPSIS
+--------
+
+*xe pif-param-clear* uuid=<PIF UUID> param-name=<parameter>
+
+
+DESCRIPTION
+-----------
+*xe pif-param-clear* attempts to clear all values for a specific writable parameter for a PIF interface.
+
+REQUIRED PARAMETERS
+-------------------
+
+*uuid*::
+ UUID of PIF interface - Use *xe pif-list* to obtain PIF interface UUIDs.
+
+*param-name*::
+ Parameter to be cleared for a PIF interface (e.g. other-config).
+
+EXAMPLES
+--------
+
+To clear all values found in the other-config parameter: ::
+ *xe pif-param-clear* uuid=<PIF UUID> param-name="other-config"
+
+SEE ALSO
+--------
+*xe-pif-list*(1), *xe-pif-param-list*(1), *xe-pif-param-remove*(1), *xe-pif-param-set*(1), *xe-network-list*(1), *xe-vlan-list*(1)
+
+BUGS
+----
+Send bugs to xen-devel@lists.xen.org, see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports. General questions can be sent to xen-api@lists.xen.org.
+
+AUTHORS
+-------
+Matthew Spah <spahmatthew@xenapiadmin.com>::
+Lisa Nguyen <lisa@xenapiadmin.com>
+
+COPYRIGHT
+---------
+Copyright \(C) 2012 - Matthew Spah, Lisa Nguyen
+
+The Howto containing this example, was offered under the following conditions:
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
+met:
+
+[options="compact"]
+. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
View
83 docs/en/man/man1/xe-pif-param-get.ad
@@ -0,0 +1,83 @@
+XE(1)
+=======
+:doctype: manpage
+:man source: xe
+:man version: {1}
+:man manual: xe pif-param-get manual
+
+NAME
+----
+
+xe-pif-param-get - Returns a parameter for a PIF interface.
+
+SYNOPSIS
+--------
+
+*xe pif-param-get* uuid=<PIF UUID> param-name=<Parameter> [ param-key=<Parameter Key> ]
+
+DESCRIPTION
+-----------
+
+*xe pif-param-get* returns parameter or key value for a specific PIF interface.
+
+REQUIRED PARAMETERS
+-------------------
+
+*uuid*::
+ UUID of PIF interface - Use *xe pif-list* to obtain PIF interface UUIDs.
+
+*param-name*::
+ Parameter for the PIF.
+
+
+OPTIONAL PARAMETERS
+-------------------
+
+*param-key*::
+ Name of key in other-config parameter (e.g. ethtool-speed).
+
+EXAMPLES
+--------
+To display the management parameter for a PIF interface: ::
+ *xe pif-param-get* uuid=<PIF UUID> param-name="management"
+
+To display the map parameter ethtool-speed: ::
+ *xe pif-param-get* uuid=<PIF UUID> param-name="other-config" param-key="ethtool-speed"
+
+
+
+SEE ALSO
+--------
+*xe-pif-list*(1), *xe-pif-param-clear*(1), *xe-pif-param-get*(1), *xe-pif-param-remove*(1),
+*xe-pif-param-set*(1), *xe-pif-param-add*(1)
+
+AUTHORS
+-------
+Matthew Spah <spahmatthew@xenapiadmin.com>::
+Lisa Nguyen <lisa@xenapiadmin.com>
+
+BUGS
+----
+See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org, General questions can be sent to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C) 2012 - Matthew Spah, Lisa Nguyen
+
+The Howto containing this example, was offered under the following conditions:
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
+met:
+
+[options="compact"]
+. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
View
67 docs/en/man/man1/xe-pif-param-list.ad
@@ -0,0 +1,67 @@
+XE(1)
+=======
+:doctype: manpage
+:man source: xe
+:man version: {1}
+:man manual: xe pif-param-list manual
+
+NAME
+----
+xe-pif-param-list - Lists all parameters for a PIF interface.
+
+SYNOPSIS
+--------
+*xe pif-param-list* uuid=<PIF UUID>
+
+DESCRIPTION
+-----------
+*xe pif-param-list* lists all parameters for a specific PIF interface.
+
+
+REQUIRED PARAMETERS
+-------------------
+*uuid*::
+ UUID of PIF interface - Use *xe pif-list* to obtain PIF interface UUIDs.
+
+
+EXAMPLES
+--------
+To display parameters for a PIF interface: ::
+ *xe pif-param-list* uuid=<PIF UUID>
+
+
+SEE ALSO
+--------
+*xe-pif-list*(1), *xe-pif-param-clear*(1), *xe-pif-scan*(1), *xe-pif-introduce*(1), *xe-network-list*(1)
+
+BUGS
+----
+See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org. General questions can be sent to xen-api@lists.xen.org.
+
+AUTHORS
+-------
+Matthew Spah <spahmatthew@xenapiadmin.com>::
+Lisa Nguyen <lisa@xenapiadmin.com>
+
+
+COPYRIGHT
+---------
+Copyright \(C) 2012 - Matthew Spah, Lisa Nguyen
+
+The Howto containing this example, was offered under the following conditions:
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
+met:
+
+[options="compact"]
+. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
View
75 docs/en/man/man1/xe-pif-param-remove.ad
@@ -0,0 +1,75 @@
+XE(1)
+=======
+:doctype: manpage
+:man source: xe
+:man version: {1}
+:man manual: xe pif-param-remove manual
+
+NAME
+----
+xe-pif-param-remove - Removes a writable parameter key for a PIF.
+
+SYNOPSIS
+--------
+*xe pif-param-remove* uuid=<PIF UUID> param-name=<Parameter> param-key=<Parameter Key>
+
+
+DESCRIPTION
+-----------
+*xe pif-param-remove* removes a set or map writable parameter key assigned to a PIF interface. Tags is one example of a set or map parameter.
+
+
+REQUIRED PARAMETERS
+-------------------
+
+*uuid*::
+ UUID of PIF interface - Use *xe pif-list* to obtain PIF interface UUIDs.
+
+*param-name*::
+ Parameter that contains parameter keys (e.g. other-config).
+
+*param-key*::
+ Parameter key that displays additional information on a PIF.
+
+EXAMPLES
+--------
+To remove the *ethtool-speed* value::
+ *xe pif-param-remove* uuid=<PIF UUID> param-name="other-config" param-key="ethtool-speed"
+
+SEE ALSO
+--------
+*xe-pif-param-set*(1), *xe-pif-param-add*(1), *xe-pif-list*(1), *xe-pif-introduce*(1), *xe-network-list*(1), *xe-vif-list*(1)
+
+
+AUTHORS
+-------
+Matthew Spah <spahmatthew@xenapiadmin.com>::
+Lisa Nguyen <lisa@xenapiadmin.com>
+
+BUGS
+----
+See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org. General questions can be sent to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C) 2012 - Matthew Spah, Lisa Nguyen
+
+The Howto containing this example, was offered under the following conditions:
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
+met:
+
+[options="compact"]
+. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

0 comments on commit 07ab18d

Please sign in to comment.