~ubuntu-branches/ubuntu/maverick/ubuntu-dev-tools/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/manage-credentials.1

  • Committer: Bazaar Package Importer
  • Author(s): Luca Falavigna
  • Date: 2009-11-28 18:48:35 UTC
  • mfrom: (18.1.66 lucid)
  • Revision ID: james.westby@ubuntu.com-20091128184835-0ot21cscixychr6b
Tags: 0.83debian1
* Merge from Ubuntu Lucid, local Debian changes:
  - Adjust Maintainer and Uploaders.
  - Depend on python-lazr.restfulclient.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH MANAGE-CREDENTIALS "1" "13 January 2009" "ubuntu-dev-tools"
 
2
.SH NAME
 
3
manage-credentials \- a tool to create (and manage) credentials which
 
4
are used to access launchpad via the API.
 
5
.SH SYNOPSIS
 
6
.B manage-credentials create -c <consumer> [--email <email> --password <password>] [--service <staging|edge>]
 
7
.br
 
8
.B manage-credentials \-h
 
9
.SH DESCRIPTION
 
10
\fBmanage-credentials\fR is a tool to create (and manage) credentials which
 
11
are used to access Launchpad via the API.
 
12
 
 
13
.PP
 
14
Currently this tool can be used
 
15
to create a token with or without using the web UI. In the future, once
 
16
related methods are available through the API, this tool can also be used
 
17
to manage tokens in launchpad and on the users local machine.
 
18
 
 
19
.SH OPTIONS
 
20
Listed below are the command line options for requestsync:
 
21
.TP
 
22
.B \-h
 
23
Display a help message and exit.
 
24
.TP
 
25
.B \-c \-\-consumer
 
26
.TP
 
27
.B \-e \-\-email <email>
 
28
Your email address as registered on Launchpad.
 
29
.TP
 
30
.B \-p \-\-password <password>
 
31
Your Launchpad password.
 
32
.TP
 
33
.B \-s \-\-service <edge|staging>
 
34
If we should use the edge or staging root of the Launchpad API.
 
35
.TP
 
36
.B \-\-cache
 
37
Where to store the cache.
 
38
.TP
 
39
.B \-o
 
40
Which file we should save the credentials to. By default
 
41
\fBmanage-credentials\fR writes the credentials tokens to the
 
42
~/.cache/lp_credentials/ directory.
 
43
.TP
 
44
.B \-l \-\-level <number>
 
45
A number representing the access-level you wish to give to the new
 
46
Launchpad token. 0 is unauthorized, 1 is read public data, 2; write public data,
 
47
3; read private data and 4; write private data.
 
48
 
 
49
.SH EXAMPLE USAGE
 
50
There are currently two ways of using \fBmanage-credentials\fR to get
 
51
Launchpad tokens.
 
52
.TP
 
53
1) manage-credentials create \-c CONSUMER \-\-level 2
 
54
 
 
55
.TP
 
56
This way shall open your webbrowser with a Launchpad login page.
 
57
 
 
58
.TP
 
59
2) manage-credentials create \-c CONSUMER \-\-level 2 \-\-password BOO \-\-email me@example.com
 
60
 
 
61
.TP
 
62
This is a hack, but it works and does not require a webbrowser .
 
63
 
 
64
.TP
 
65
If you intend to use manage-credentials for Ubuntu development (such as
 
66
the ubuntu-dev-tools package). Please by sure to run the following:
 
67
 
 
68
.TP
 
69
manage-credentials create \-c ubuntu-dev-tools \-l 2
 
70
 
 
71
.SH AUTHOR
 
72
.B manage-credentials
 
73
was written by Markus Korn <thekorn@gmx.de> and this manual page was written by
 
74
Jonathan Davies <jpds@ubuntu.com>.
 
75
.PP
 
76
Both are released under the GNU General Public License, version 3.