update INSTALL section

[opensuse:osc.git] / README

osc -- opensuse-commander with svn like handling

>>> BUG: at the moment, 'up' overwrites files with
         local modifications.


Please send patches to poeml@suse.de, or work directly on
https://forgesvn1.novell.com/svn/opensuse/trunk/buildservice/src/clientlib/python/osc/


INSTALLATION:

        python setup.py build
        python setup.py install
        # create a symlink 'osc' in your path pointing to osc.py.
        ln -s osc-wrapper.py /usr/bin/osc

Alternatively, you can directly use osc-wrapper.py from the source dir


The program needs the following python packages installed (that's their names
on SUSE anyway): 
        pyxml 
        python-elementtree




CONFIGURATION:

For authentication, put your account data into your ~/.netrc file, like this
line:
        machine api.opensuse.org login $login password $pass 




USAGE EXAMPLES:

osc ls                          # list projects
osc ls Apache                   # list packages in a project 
osc ls Apache subversion        # list files of package of a project

# check out 
osc co Apache                   # entire project
osc co Apache subversion        # a package
osc co Apache subversion foo    # single file

# update working copy
osc up
osc up <directory>

# check in
osc ci                          # current dir
osc ci <dir>
osc ci file1 file2 ...

# show status
osc st
osc st <directory>

# initialize a source directory to be a 
# working copy of project <prj> package <pac>
osc init <prj> <pac>

# schedule file foo to be added / deleted
osc add foo
osc rm foo

# add all unknown files and remove all missing files
osc addremove

# show diff
osc diff [file]

# show build results (xml)
osc results
osc results [platform]

# show logfile (must be run from workingdir)
osc log <platform> <arch>

# show platforms
osc platforms
# show platforms used by project Apache
osc platforms Apache

# show various xml meta
osc meta Apache
osc meta Apache subversion
osc id username