feature #4215: add onevrouter man page

share/man/onevrouter.1

@@ -0,0 +1,100 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "ONEVROUTER" "1" "January 2016" "" "onevrouter(1) -- manages OpenNebula Virtual Routers"
+.
+.SH "NAME"
+\fBonevrouter\fR \- manages OpenNebula Virtual Routers
+.
+.SH "SYNOPSIS"
+\fBonevrouter\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
+.
+.SH "OPTIONS"
+.
+.nf
+
+ \-a, \-\-append              Append new attributes to the current template
+ \-l, \-\-list x,y,z          Selects columns to display with list command
+ \-d, \-\-delay x             Sets the delay in seconds for top command
+ \-f, \-\-filter x,y,z        Filter data\. An array is specified with
+                           column=value pairs\.
+ \-\-csv                     Write table in csv format
+ \-x, \-\-xml                 Show the resource in xml format
+ \-n, \-\-numeric             Do not translate user and group IDs
+ \-\-describe                Describe list columns
+ \-v, \-\-verbose             Verbose mode
+ \-h, \-\-help                Show this message
+ \-V, \-\-version             Show version and copyright information
+ \-\-user name               User name used to connect to OpenNebula
+ \-\-password password       Password to authenticate with OpenNebula
+ \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
+.
+.fi
+.
+.SH "COMMANDS"
+.
+.IP "\(bu" 4
+create \fIfile\fR Creates a new Virtual Router from the given description
+.
+.IP "\(bu" 4
+delete \fIrange|vrouterid_list\fR Deletes the given Virtual Router
+.
+.IP "\(bu" 4
+chgrp \fIrange|vrouterid_list\fR \fIgroupid\fR Changes the Virtual Router group
+.
+.IP "\(bu" 4
+chown \fIrange|vrouterid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Router owner and group
+.
+.IP "\(bu" 4
+chmod \fIrange|vrouterid_list\fR \fIoctet\fR Changes the Virtual Router permissions
+.
+.IP "\(bu" 4
+update \fIvrouterid\fR [\fIfile\fR] Update the Virtual Router contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
+.
+.IP "\(bu" 4
+rename \fIvrouterid\fR \fIname\fR Renames the Virtual Router
+.
+.IP "\(bu" 4
+list [\fIfilterflag\fR] Lists the Virtual Routers in the pool valid options: list, delay, filter, csv, xml, numeric, describe
+.
+.IP "\(bu" 4
+show \fIsecgroupid\fR Shows information for the given Virtual Router valid options: xml
+.
+.IP "\(bu" 4
+top [\fIfilterflag\fR] Lists Virtual Routers continuously valid options: list, delay, filter, csv, xml, numeric, describe
+.
+.IP "" 0
+.
+.SH "ARGUMENT FORMATS"
+.
+.IP "\(bu" 4
+file Path to a file
+.
+.IP "\(bu" 4
+range List of id\'s in the form 1,8\.\.15
+.
+.IP "\(bu" 4
+text String
+.
+.IP "\(bu" 4
+groupid OpenNebula GROUP name or id
+.
+.IP "\(bu" 4
+userid OpenNebula USER name or id
+.
+.IP "\(bu" 4
+vrouterid OpenNebula VROUTER name or id
+.
+.IP "\(bu" 4
+vrouterid_list Comma\-separated list of OpenNebula VROUTER names or ids
+.
+.IP "\(bu" 4
+filterflag a, all all the known VROUTERs m, mine the VROUTER belonging to the user in ONE_AUTH g, group \'mine\' plus the VROUTER belonging to the groups the user is member of uid VROUTER of the user identified by this uid user VROUTER of the user identified by the username
+.
+.IP "" 0
+.
+.SH "LICENSE"
+OpenNebula 4\.14\.1 Copyright 2002\-2015, OpenNebula Project, OpenNebula Systems
+.
+.P
+Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0