Skip to content
Snippets Groups Projects
Commit 69bfc344 authored by gaetan deleaz's avatar gaetan deleaz
Browse files

man page update

parent c13e8de6
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 39 additions and 33 deletions
debian/cc-cli.1
+ 39
− 33
View file @ 69bfc344
...@@ -45,15 +45,15 @@ History max entry count ...@@ -45,15 +45,15 @@ History max entry count
.SS Loading procedure: .SS Loading procedure:
Configuration is loaded in this order: Configuration is loaded in this order:
.br .br
1 Check \fBCC_DEBUG\fP, to set early debugging mode 1 - Check \fBCC_DEBUG\fP, to set early debugging mode
.br .br
2 load [cli] profile from \fB~/.config/cc-cli/profile\fP 2 - load [cli] profile from \fB~/.config/cc-cli/profile\fP
.br .br
3 load profile specified by option profile (arg line, env, cli profile) 3 - load profile specified by option profile (arg line, env, cli profile)
.br .br
4 load options from environment 4 - load options from environment
.br .br
5 load options from command line 5 - load options from command line
.SH TQL .SH TQL
TQL (text query language) TQL (text query language)
...@@ -107,16 +107,16 @@ TQL (text query language) ...@@ -107,16 +107,16 @@ TQL (text query language)
.br .br
\fB>=\fP superior \fB>=\fP superior
.br .br
\fB<\fP inferior \fB<\fP inferior strict
.br .br
\fB<=\fP inferior strict \fB<=\fP inferior
.br .br
Each previous operators can be negated by adding \fB!\fP before it. Each previous operators can be negated by adding \fB!\fP before it.
.SS LIMITING CONDITIONS .SS LIMITING CONDITIONS
\fBn\fP limit to n first objects \fBn\fP limit to n first objects
.br .br
\fB,n\fP limit from n objects to last object \fB,n\fP limit from n object to last object
.SS NUMBER FACILITY .SS NUMBER FACILITY
\fB10k\fP = 1000 \fB10k\fP = 1000
...@@ -137,7 +137,6 @@ For example, See the command \fBlist\fP ...@@ -137,7 +137,6 @@ For example, See the command \fBlist\fP
.SH GENERIC COMMANDS .SH GENERIC COMMANDS
.SS addaccount [\fIoptions\fP] \fI<account-name> <role>\fP [\fIpassword\fP] .SS addaccount [\fIoptions\fP] \fI<account-name> <role>\fP [\fIpassword\fP]
.TP
Create an account Create an account
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -170,7 +169,7 @@ Add or edit account right ...@@ -170,7 +169,7 @@ Add or edit account right
.br .br
All is deny by default All is deny by default
.br .br
When a user tape a command, cli check the rights from index 0, if the method and the right tql match whith command, right is applied, else it check the next rights, and if not found a matching rights, it deny the command When a user tape a command, cli check the rights from index 0 to the last, if the method and the right tql match whith command, right is applied, else it check the next rights, and if not found a matching rights, it deny the command
.TP .TP
Example: Example:
\fB[0] tql: method:* target:allow\fP \fB[0] tql: method:* target:allow\fP
...@@ -228,7 +227,6 @@ No output coloration ...@@ -228,7 +227,6 @@ No output coloration
Deny method list whith tql "id=toto" for account toto in index 0 (deny commands' example: list id=toto, list id:t*, ...) Deny method list whith tql "id=toto" for account toto in index 0 (deny commands' example: list id=toto, list id:t*, ...)
.SS alias [\fIoptions\fP] [\fIname\fP] [\fIvalue\fP] .SS alias [\fIoptions\fP] [\fIname\fP] [\fIvalue\fP]
.TP
Show or create alias Show or create alias
.TP .TP
CLI support aliasing. This is a very useful command substitution. Alias is stored in \fB~/.config/cc-cli/alias\fP CLI support aliasing. This is a very useful command substitution. Alias is stored in \fB~/.config/cc-cli/alias\fP
...@@ -251,7 +249,6 @@ Setting an alias vm, which list running vm (and show cpu) ...@@ -251,7 +249,6 @@ Setting an alias vm, which list running vm (and show cpu)
Clear tty Clear tty
.SS close [\fIoptions\fP] \fI<tql>\fP .SS close [\fIoptions\fP] \fI<tql>\fP
.TP
Disable accounts Disable accounts
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -281,7 +278,6 @@ No tagdisplay custom display ...@@ -281,7 +278,6 @@ No tagdisplay custom display
No output coloration No output coloration
.SS declose [\fIoptions\fP] \fI<tql>\fP .SS declose [\fIoptions\fP] \fI<tql>\fP
.TP
Enable accounts Enable accounts
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -311,7 +307,6 @@ No tagdisplay custom display ...@@ -311,7 +307,6 @@ No tagdisplay custom display
No output coloration No output coloration
.SS delaccount [\fIoptions\fP] \fI<tql>\fP .SS delaccount [\fIoptions\fP] \fI<tql>\fP
.TP
Delete an account Delete an account
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -341,7 +336,6 @@ No tagdisplay custom display ...@@ -341,7 +336,6 @@ No tagdisplay custom display
No output coloration No output coloration
.SS delright [\fIoptions\fP] \fI<tql> <index>\fP .SS delright [\fIoptions\fP] \fI<tql> <index>\fP
.TP
Delete account right Delete account right
.TP .TP
...@@ -393,14 +387,12 @@ Print help ...@@ -393,14 +387,12 @@ Print help
.SS history .SS history
.TP
Show commands history Show commands history
CLI history is stored in \fB~/.local/share/cc-cli/history\fP CLI history is stored in \fB~/.local/share/cc-cli/history\fP
.SS kill [\fIoptions\fP] \fI<tql>\fP .SS kill [\fIoptions\fP] \fI<tql>\fP
.TP
Kill a server connection Kill a server connection
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -431,7 +423,6 @@ No output coloration ...@@ -431,7 +423,6 @@ No output coloration
.SS list [\fIoptions\fP] [\fItql\fP] .SS list [\fIoptions\fP] [\fItql\fP]
.TP
List objects List objects
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -509,7 +500,6 @@ line aligment display ...@@ -509,7 +500,6 @@ line aligment display
.SS passwd [\fIoptions\fP] [\fItql\fP] [\fIpassword\fP] .SS passwd [\fIoptions\fP] [\fItql\fP] [\fIpassword\fP]
.TP
Change account password Change account password
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -540,12 +530,10 @@ No output coloration ...@@ -540,12 +530,10 @@ No output coloration
.SS quit .SS quit
.TP
Quit application with respect Quit application with respect
.SS rights [\fIoptions\fP] [\fItql\fP] .SS rights [\fIoptions\fP] [\fItql\fP]
.TP
List account rights List account rights
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -574,7 +562,6 @@ Display right for account with id toto. ...@@ -574,7 +562,6 @@ Display right for account with id toto.
The user toto doesn't have right use method list whith a tql conained "id=toto" (deny commands' example: list id=toto, list id:t*, ...) The user toto doesn't have right use method list whith a tql conained "id=toto" (deny commands' example: list id=toto, list id:t*, ...)
.SS server \fI<options>\fP .SS server \fI<options>\fP
.TP
Server manipulation command Server manipulation command
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -593,7 +580,6 @@ show server version ...@@ -593,7 +580,6 @@ show server version
.SS shutdown [\fIoptions\fP] \fI<tql>\fP .SS shutdown [\fIoptions\fP] \fI<tql>\fP
.TP
Shutdown a physical host Shutdown a physical host
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -633,7 +619,6 @@ do not go through init but go down real fast ...@@ -633,7 +619,6 @@ do not go through init but go down real fast
.SS unalias [\fIoptions\fP] [\fIname\fP] .SS unalias [\fIoptions\fP] [\fIname\fP]
.TP
Remove an alias Remove an alias
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -642,19 +627,15 @@ Remove an alias ...@@ -642,19 +627,15 @@ Remove an alias
show this help message and exit show this help message and exit
.SS usage \fI<command>\fP .SS usage \fI<command>\fP
.TP
Print usage of a command Print usage of a command
.SS version .SS version
.TP
Print cli version Print cli version
.SS whoami .SS whoami
.TP
Show connection login Show connection login
.SH TAG COMMANDS .SH TAG COMMANDS
Every tag is composed by a tagname and a tagvalue Every tag is composed by a tagname and a tagvalue
.br .br
- Tagname are case insensitive, tagvalue is case sensitive - Tagname are case insensitive, tagvalue is case sensitive
...@@ -779,7 +760,6 @@ Reserved tags are tags with a special meaning and cannot be set or remove direct ...@@ -779,7 +760,6 @@ Reserved tags are tags with a special meaning and cannot be set or remove direct
.SS addtag [\fIoptions\fP] \fI<tql> <tag> <value>\fP .SS addtag [\fIoptions\fP] \fI<tql> <tag> <value>\fP
.TP
Add/Modify a static tag on an account Add/Modify a static tag on an account
.TP .TP
\fBOptions:\fP \fBOptions:\fP
...@@ -905,6 +885,14 @@ No tagdisplay custom display ...@@ -905,6 +885,14 @@ No tagdisplay custom display
.TP .TP
\fB--no-color\fP \fB--no-color\fP
No output coloration No output coloration
.TP
\fBExample:\fP
\fB>>tags r=cli\fP
id=\fBtoto\fP foo=bar hello=bye
.br
id=\fBtiti\fP az=qwerty
.br
List all clients' static tags
.SH JOB COMMANDS .SH JOB COMMANDS
...@@ -978,7 +966,15 @@ No tagdisplay custom display ...@@ -978,7 +966,15 @@ No tagdisplay custom display
.TP .TP
\fB--no-color\fP \fB--no-color\fP
No output coloration No output coloration
.TP
\fBExample:\fP
.TP
\fBexecute r=hv ls\fP
Execute command ls in all hosts
.TP
.B BUG:
.br
Quand il y a une erreur, il manque un retour à la ligne apres le None
.SS jobs [\fIoptions\fP] [\fItql\fP] .SS jobs [\fIoptions\fP] [\fItql\fP]
List jobs List jobs
...@@ -1011,6 +1007,8 @@ Don't show running jobs ...@@ -1011,6 +1007,8 @@ Don't show running jobs
.SS migrate [\fIoptions\fP] [\fIsource-tql\fP] [\fIdest-tql\fP] .SS migrate [\fIoptions\fP] [\fIsource-tql\fP] [\fIdest-tql\fP]
Migrate vm Migrate vm
Migrate vm from host [\fIsource-tql\fP] to another host [\fIdest-tql\fP]. Only \fBcold\fP (the virtual machine stop to execute any currently working program and copy the current page table to the machine where the virtual machine migrate) type migration and \fBfair\fP algorithm are available.
.TP .TP
\fBOptions:\fP \fBOptions:\fP
.TP .TP
...@@ -1040,8 +1038,8 @@ Select migration algorithm ...@@ -1040,8 +1038,8 @@ Select migration algorithm
.TP .TP
\fBExample:\fP \fBExample:\fP
.TP .TP
\fBmigrate r=vm&p=host1 id=host2\fP \fBmigrate -t cold -a fair r=vm&p=host1 id=host2\fP
Migrate all vm in host1 to host2 Migrate all vm from host1 to host2
.SS pause [\fIoptions\fP] \fI<tql>\fP .SS pause [\fIoptions\fP] \fI<tql>\fP
Pause a running vm Pause a running vm
...@@ -1076,6 +1074,15 @@ No output coloration ...@@ -1076,6 +1074,15 @@ No output coloration
.TP .TP
\fBpause r=vm&status=running&p=host1\fP \fBpause r=vm&status=running&p=host1\fP
Pause all vm started in the hypervisor host1 Pause all vm started in the hypervisor host1
.TP
\fBBUG:\fP
.br
pause --print-tql r=vm&status=running&p=it-test-4
.br
TQL: r=vm&status=running&p=it-test-4&r=vm&status=stopped
.br
le TQL devrait ressembler plus à : r=vm&status=running&p=it-test-4&r=vm&status!=stopped
.SS resume [\fIoptions\fP] \fI<tql>\fP .SS resume [\fIoptions\fP] \fI<tql>\fP
Resume a paused vm Resume a paused vm
...@@ -1111,7 +1118,6 @@ No tagdisplay custom display ...@@ -1111,7 +1118,6 @@ No tagdisplay custom display
No output coloration No output coloration
.SS start [\fIoptions\fP] \fI<tql>\fP .SS start [\fIoptions\fP] \fI<tql>\fP
.TP
Start a stopped vm Start a stopped vm
.TP .TP
\fBOptions:\fP \fBOptions:\fP
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment