use redirector url
[opensuse:osc.git] / README
1 osc -- opensuse-commander with svn like handling
2
3 >>> BUG: at the moment, 'up' overwrites files with
4          local modifications.
5
6
7 Please send patches to poeml@suse.de, or work directly on
8 https://forgesvn1.novell.com/svn/opensuse/trunk/buildservice/src/clientlib/python/osc/
9
10
11 INSTALLATION:
12
13 RPM packages are here (yum repository):
14 http://software.opensuse.org/download/repositories/openSUSE:Tools/
15
16 To install from svn, do
17         python setup.py build
18         python setup.py install
19         # create a symlink 'osc' in your path pointing to osc.py.
20         ln -s osc-wrapper.py /usr/bin/osc
21
22 Alternatively, you can directly use osc-wrapper.py from the source dir
23
24
25 The program needs the following python packages installed (that's their names
26 on SUSE anyway): 
27         pyxml 
28         python-elementtree
29
30
31
32
33 CONFIGURATION:
34
35 osc uses authentication data if it finds it in .netrc, otherwise it will ask
36 for username/password once, and store it in ~/.oscrc.
37
38
39
40 USAGE EXAMPLES:
41
42 osc ls                          # list projects
43 osc ls Apache                   # list packages in a project 
44 osc ls Apache subversion        # list files of package of a project
45
46 # check out 
47 osc co Apache                   # entire project
48 osc co Apache subversion        # a package
49 osc co Apache subversion foo    # single file
50
51 # update working copy
52 osc up
53 osc up <directory>
54 osc up *                        # from within a project dir, update all packages
55
56 # check in
57 osc ci                          # current dir
58 osc ci <dir>
59 osc ci file1 file2 ...
60
61 # show status
62 osc st
63 osc st <directory>
64 osc st file1 file2 ...
65
66 # initialize a source directory to be a 
67 # working copy of project <prj> package <pac>
68 osc init <prj> <pac>
69
70 # schedule files foo to be added / deleted
71 osc add file1 file2 ...
72 osc rm file1 file2 ...
73
74 # add all unknown files AND remove all missing files
75 osc addremove
76
77 # show diff
78 osc diff                        # current dir
79 osc diff file1 file2 ...
80
81 # show build results (xml)
82 osc results
83 osc results [platform]
84
85 # show logfile (must be run from workingdir)
86 osc log <platform> <arch>
87
88 # show platforms
89 osc platforms
90 # show platforms used by project Apache
91 osc platforms Apache
92
93 # show various xml meta
94 osc meta Apache
95 osc meta Apache subversion
96 osc id username
97
98
99
100
101 HINT FOR W3M USERS
102
103 Putting the following in the file ~/.w3m/passwd will make
104 w3m know the credentials for the buildservice servers:
105
106 """
107 host api.opensuse.org
108   port 80
109   realm Authentication required
110   login foo
111   password bar
112
113 host build.opensuse.org
114   port 80
115   realm openSUSE Build Service
116   login foo
117   password bar
118 """
119
120 chmod 0600 ~/.w3m/passwd