Revision 17854c69

b/docs/conf.py
41 41

  
42 42
# General information about the project.
43 43
project = u'Kamaki'
44
copyright = u'2011, GRNet'
44
copyright = u'2012, GRNet'
45 45

  
46 46
# The version info for the project you're documenting, acts as replacement for
47 47
# |version| and |release|, also used in various other places throughout the
......
213 213
# One entry per manual page. List of tuples
214 214
# (source start file, name, description, authors, manual section).
215 215
man_pages = [
216
    ('index', 'kamaki', u'Kamaki Documentation',
217
     [u'GRNet'], 1)
216
    ('man/kamaki', 'kamaki', 'Command-line tool for managing clouds', '', 1),
218 217
]
219 218

  
220 219
# If true, show URL addresses after external links.
b/docs/man/kamaki.rst
1
:orphan:
2

  
3
kamaki tool manual page
4
=======================
5

  
6
Synopsis
7
--------
8

  
9
**kamaki** <*group*> <*command*> [*options*]
10

  
11

  
12
Description
13
-----------
14

  
15
:program:`kamaki` is a simple, yet intuitive, command-line tool for managing 
16
clouds.
17

  
18
List of available groups:
19

  
20
config
21

  
22
    Edit configuration options. Config options are stored in ~/.kamakirc file.
23

  
24
server
25

  
26
    Manage compute API virtual machines.
27

  
28
flavor
29

  
30
    Manage compute API flavors.
31

  
32
image
33

  
34
    Manage compute API images.
35

  
36
network
37

  
38
    Manage compute API networks.
39

  
40
glance
41

  
42
    Manage Glance API images.
43

  
44
store
45

  
46
    Manage store API.
47

  
48

  
49
Options
50
-------
51

  
52
--help                  Show help message and exit.
53
-v                      Use verbose output.
54
-d                      Use debug output.
55
-o KEY=VAL              Override a config value (can be used multiple times)
56

  
57

  
58
Commands
59
--------
60

  
61
config commands
62
***************
63

  
64
* list       list configuration options
65
* get        get a configuration option
66
* set        set a configuration option
67
* del        delete a configuration option
68

  
69

  
70

  
71
server commands
72
***************
73

  
74
* list       list servers
75
* info       get server details
76
* create     create server
77
* rename     update server name
78
* delete     delete server
79
* reboot     reboot server
80
* start      start server
81
* shutdown   shutdown server
82
* console    get a VNC console
83
* firewall   set the firewall profile
84
* addr       list server addresses
85
* meta       get server metadata
86
* addmeta    add server metadata
87
* setmeta    update server metadata
88
* delmeta    delete server metadata
89
* stats      get server statistics
90

  
91

  
92
flavor commands
93
***************
94

  
95
* list       list flavors
96
* info       get flavor details
97

  
98

  
99
image commands and options
100
**************************
101

  
102
* list       list images
103
* info       get image details
104
* delete     delete image
105
* meta       get image metadata
106
* addmeta    add image metadata
107
* setmeta    update image metadata
108
* delmeta    delete image metadata
109

  
110

  
111
network commands
112
****************
113

  
114
* list       list networks
115
* create     create a network
116
* info       get network details
117
* rename     update network name
118
* delete     delete a network
119
* connect    connect a server to a network
120
* disconnect disconnect a server from a network
121

  
122

  
123
glance commands
124
***************
125

  
126
* list       list images
127
* meta       get image metadata
128
* register   register an image
129
* members    get image members
130
* shared     list shared images
131
* addmember  add a member to an image
132
* delmember  remove a member from an image
133
* setmembers set the members of an image
134

  
135

  
136
store commands
137
**************
138

  
139
* create     create a container
140
* container  get container info
141
* upload     upload a file
142
* download   download a file
143
* delete     delete a file
144

  
145

  
146
Author
147
------
148

  
149
GRNET development team <synnefo@lists.grnet.gr>.
150

  

Also available in: Unified diff