1OSC(1) User Commands OSC(1)
2
6 osc - openSUSE build service command-line tool.
7
9 osc [GLOBALOPTS] SUBCOMMAND [OPTS] [ARGS...]
10 osc help SUBCOMMAND
11
13 openSUSE build service command-line tool.
14 COMMANDS
17 add Mark files to be added upon the next commit
18 In case a URL is given the file will get downloaded and regis‐
20 tered to be downloaded by the server as well via the down‐
21 load_url source service.
22 This is recommended for release tar balls to track their source
24 and to help others to review your changes esp. on version up‐
25 grades.
26 usage:
28 osc add URL [URL...]
29 osc add FILE [FILE...] Options:
30 -h, --help show this help message and exit
31 -f, --force
32 add files even if they are excluded by the
33 exclude_glob config option
34 addchannels
38 Add channels to project.
39 The command adds all channels which are defined to be used for a
41 given source package. The source link target is used to lookup
42 the channels. The command can be used for a certain package or
43 for all in the specified project.
44 In case no channel is defined the operation is just returning.
46 Examples:
48 osc addchannels [PROJECT [PACKAGE]] Options:
49 -h, --help show this help message and exit
50 -e, --enable-all
51 Enable all added channels including the ones
52 disabled
53 by default.
54 -s, --skip-disabled
55 Skip disabled channels. Otherwise the source
56 gets
57 added, but not the repositories.
58 addcontainers
62 Add maintained containers for a give package
63 The command adds all containers which are marked as maintained
65 and contain an rpm originating from the specified source pack‐
66 age.
67 Examples:
69 osc addcontainers [PROJECT PACKAGE] Options:
70 -h, --help show this help message and exit
71 --extend-package-names
72 Extend packages names with project name as suf‐
73 fix
74 addremove (ar)
78 Adds new files, removes disappeared files
79 Adds all files new in the local copy, and removes all disap‐
81 peared files.
82 ARG, if specified, is a package working copy.
84 Usage:
86 osc addremove [ARGS...]
87 Options:
89 -h, --help show this help message and exit
90 -r, --recursive
91 If CWD is a project dir then scan all package
92 dirs as
93 well
94 aggregatepac
98 "Aggregate" a package to another package
99 Aggregation of a package means that the build results (binaries)
101 of a package are basically copied into another project. This
102 can be used to make packages available from building that are
103 needed in a project but available only in a different project.
104 Note that this is done at the expense of disk space. See
105 http://en.opensuse.org/openSUSE:Build_Ser‐
106 vice_Tips_and_Tricks#link_and_aggregate for more information.
107 The DESTPAC name is optional; the source packages' name will be
109 used if DESTPAC is omitted.
110 usage:
112 osc aggregatepac SOURCEPRJ SOURCEPAC[:FLAVOR] DESTPRJ [DEST‐
113 PAC] Options:
114 -h, --help show this help message and exit
115 -d, --disable-publish
116 disable publishing of the aggregated package
117 -m SRC=TARGET[,SRC=TARGET], --map-repo=SRC=TARGET[,SRC=TAR‐
118 GET]
119 Allows repository mapping(s) to be given as
120 SRC=TARGET[,SRC=TARGET]
121 --nosources
122 ignore source packages when copying build re‐
123 sults to
124 destination project
125 api Issue an arbitrary request to the API
129 Useful for testing.
131 URL can be specified either partially (only the path component),
133 or fully with URL scheme and hostname ('http://...').
134 Note the global -A and -H options (see osc help).
136 Examples:
138 osc api /source/home:user
139 osc api -X PUT -T /etc/fstab source/home:user/test5/myfstab
140 osc api -e /configuration
141 Usage:
143 osc api URL
144 Options:
146 -h, --help show this help message and exit
147 -a NAME STRING, --add-header=NAME STRING
148 add the specified header to the request
149 -T FILE, -f FILE, --file=FILE
150 specify filename to upload, uses PUT mode by de‐
151 fault
152 -d STRING, --data=STRING
153 specify string data for e.g. POST
154 -e, --edit GET, edit and PUT the location
155 -X HTTP_METHOD, -m HTTP_METHOD, --method=HTTP_METHOD
156 specify HTTP method to use (GET|PUT|DELETE|POST)
157 branch (bco, branchco, getpac)
161 Branch a package
162 [See http://en.opensuse.org/openSUSE:Build_Service_Collaboration
164 for information on this topic.]
165 Create a source link from a package of an existing project to a
167 new subproject of the requesters home project (home:branches:)
168 The branched package will live in
170 home:USERNAME:branches:PROJECT/PACKAGE if nothing else spec‐
171 ified.
172 With getpac or bco, the branched package will come from one of
174 openSUSE:Factory (list of projects from oscrc:getpac_de‐
175 fault_project) if nothing else is specfied on the command line.
176 In case of branch errors, where the source has currently merge
178 conflicts use --linkrev=base option.
179 usage:
181 osc branch
182 osc branch SOURCEPROJECT SOURCEPACKAGE
183 osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT
184 osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT TARGET‐
185 PACKAGE
186 osc getpac SOURCEPACKAGE
187 osc bco ... Options:
188 -h, --help show this help message and exit
189 --add-repositories-rebuild=add_repositories_rebuild
190 specify the used rebuild strategy for new repos‐
191 itories
192 --add-repositories-block=add_repositories_block
193 specify the used block strategy for new reposi‐
194 tories
195 --linkrev=linkrev
196 specify the used revision in the link target.
197 -r rev, --revision=rev
198 branch against a specific revision
199 -N, --new-package
200 create a branch pointing to a not yet existing
201 package
202 -M, --maintenance
203 Create project and package in maintenance mode
204 -m TEXT, --message=TEXT
205 specify message TEXT
206 --noaccess Create a hidden project
207 --extend-package-names
208 Extend packages names with project name as suf‐
209 fix
210 --add-repositories
211 Add repositories to target project (happens by
212 default
213 when project is new)
214 -f, --force
215 force branch, overwrite target
216 -c, --checkout
217 Checkout branched package afterwards using "co
218 -e
219 -S"('osc bco' is a shorthand for this option)
220 --nodevelproject
221 do not follow a defined devel project (primary
222 project
223 where a package is developed)
224 browse opens browser
228 usage:
230 osc browse [PROJECT [PACKAGE]]
231 build (chroot, shell, wipe)
235 Build a package on your local machine
236 You need to call the command inside a package directory, which
238 should be a buildsystem checkout. (Local modifications are
239 fine.)
240 The arguments REPOSITORY and ARCH can be taken from the first
242 two columns of the 'osc repos' output. BUILD_DESCR is either a
243 RPM spec file, or a Debian dsc file.
244 The command honors packagecachedir, build-root and build-uid
246 settings in oscrc, if present. You may want to set su-wrapper =
247 'sudo' in oscrc, and configure sudo with option NOPASSWD for
248 /usr/bin/build.
249 If neither --clean nor --noinit is given, build will reuse an
251 existing build-root again, removing unneeded packages and add
252 missing ones. This is usually the fastest option.
253 If the package doesn't exist on the server please use the --lo‐
255 cal-package option. If the project of the package doesn't exist
256 on the server please use the --alternative-project <alternative-
257 project> option: Example:
258 osc build [OPTS] --alternative-project openSUSE:10.3 stan‐
259 dard i586 BUILD_DESCR
260 usage:
262 osc build [OPTS] # will try to guess a
263 build environement
264 osc build [OPTS] REPOSITORY ARCH BUILD_DESCR
265 osc build [OPTS] REPOSITORY ARCH
266 osc build [OPTS] REPOSITORY (ARCH = hostarch, BUILD_DESCR is
267 detected automatically)
268 osc build [OPTS] ARCH (REPOSITORY = build_repository (config
269 option), BUILD_DESCR is detected automatically)
270 osc build [OPTS] BUILD_DESCR (REPOSITORY = build_repository
271 (config option), ARCH = hostarch)
272 osc build [OPTS] (REPOSITORY = build_repository (config op‐
273 tion), ARCH = hostarch, BUILD_DESCR is detected automatically)
274 For debugging purposes you can run after a build the following
276 to jump inside of of the build environemnt:
277 osc shell [OPTS] REPOSITORY ARCH
279 Run a single command inside of the build environment:
281 osc shell --shell-cmd=COMMAND [OPTS] REPOSITORY ARCH
282 OPTS may be
284 --noinit # for faster run
286 --shell-cmd=COMMAND
287 --shell-after-fail
288 --extra-pkgs=PACKAGE # install additional packages
289 To clean up the build environment run
291 osc wipe [OPTS]
293 osc wipe [OPTS] REPOSITORY ARCH
294 You may set the used VM type in oscrc already, but you can also
296 overwrite it for example with
297 --vm-type=chroot # for faster, but uncleaner and unse‐
299 cure build
300 --vm-type=kvm # for clean and secure build
301 --vm-type=qemu # for slow cross architecture build us‐
302 ing system emulator
303 # Note: # Configuration can be overridden by envvars, e.g. #
305 OSC_SU_WRAPPER overrides the setting of su-wrapper. #
306 OSC_BUILD_ROOT overrides the setting of build-root. # OSC_PACK‐
307 AGECACHEDIR overrides the setting of packagecachedir.
308 Options:
310 -h, --help show this help message and exit
311 --nopreinstallimage, --no-preinstallimage
312 Do not use preinstall images for creating the
313 build
314 root.
315 --trust-all-projects
316 trust packages from all projects
317 --host=HOST
318 perform the build on a remote server -
319 user@server:~/remote/directory
320 -f, --force
321 Do not ask for confirmation to wipe
322 --shell-cmd=COMMAND
323 run specified command instead of bash
324 --shell-after-fail
325 run a shell if the build tool fails
326 --verbose=VERBOSE
327 set a verbose mode, arguments can be "all" or
328 "vm"
329 --oldpackages=DIR
330 take previous build from DIR (special values:
331 _self,
332 _link)
333 --download-api-only
334 only fetch packages from the api
335 --disable-cpio-bulk-download
336 disable downloading packages as cpio archive
337 from api
338 --release=N
339 set release number of the package to N
340 -b, --baselibs
341 Create -32bit/-64bit/-x86 rpms for other archi‐
342 tectures
343 --disable-debuginfo
344 disable build of debuginfo packages
345 -d, --debuginfo
346 also build debuginfo sub-packages
347 --alternative-project=PROJECT
348 specify the build target project
349 --target=TARGET
350 define target platform
351 --vm-telnet=TELNET
352 Launch a telnet server inside of VM build
353 --vm-type=TYPE
354 use VM type TYPE (e.g. kvm)
355 --vm-disk-size=DISKSIZE
356 size for newly created disk image in MB
357 --vm-memory=MEMORY
358 amount of memory for VM defined in MB
359 --linksources
360 use hard links instead of a deep copied source
361 --stage=STAGE
362 runs a specific stage, default is "a" for all.
363 Append
364 a trailing "="to only run the specified stage.
365 Append
366 a trailing "+" to runthe specified stage and all
367 stages coming after it. With nosuffix, stages up
368 to
369 and included the specified stage are run.
370 --local-package
371 build a package which does not exist on the
372 server
373 --build-uid=uid:gid|"caller"
374 specify the numeric uid:gid pair to assign to
375 the
376 unprivileged "abuild" user or use "caller" to
377 use the
378 current user uid:gid
379 --userootforbuild, --login-as-root
380 Run build or shell as root. The default is to
381 build as
382 unprivileged user. Note that a line "# noroot‐
383 forbuild"
384 in the spec file will invalidate this option.
385 --build-opt=OPT
386 pass option OPT to the build command
387 --define='X Y'
388 define macro X with value Y
389 --without=X
390 disable feature X for build
391 --with=X enable feature X for build
392 --sccache-uri=redis://127.0.0.1:6389
393 Optional remote URI for sccache storage. Implies
394 --sccache.
395 --sccache use sccache to speed up rebuilds. Conflicts with
396 --cache
397 --pkg-ccache=/path/to/_ccache.tar
398 path to an existing uncompressed archive ccache.
399 Using
400 this option implies --ccache
401 --ccache use ccache to speed up rebuilds
402 --icecream=N
403 use N parallel build jobs with icecream
404 -t N, --threads=N
405 Compile with N threads
406 -j N, --jobs=N
407 Compile with N jobs
408 --root=ROOT
409 Build in specified directory
410 -x PAC, --extra-pkgs=PAC
411 Add this package when installing the build-root
412 -M MPAC, --multibuild-package=MPAC
413 Build the specified multibuild package
414 -k DIR, --keep-pkgs=DIR
415 Save built packages into this directory
416 -p DIR, --prefer-pkgs=DIR
417 Prefer packages from this directory when in‐
418 stalling
419 the build-root
420 --noservice, --no-service
421 Skip run of local source services as specified
422 in
423 _service file.
424 --nodebugpackages, --no-debug-packages
425 Skip installation of additional debug packages
426 for CLI
427 builds
428 --no-verify, --noverify
429 Skip signature verification (via pgp keys) of
430 packages
431 used for build. (Global config in oscrc: no_ver‐
432 ify)
433 --nochecks, --no-checks
434 Do not run build checks on the resulting pack‐
435 ages.
436 --noinit, --no-init
437 Skip initialization of build root and start with
438 build
439 immediately.
440 --overlay=OVERLAY
441 Copy overlay filesystem to buildroot after in‐
442 stalling
443 all RPMs .
444 --rsync-dest=RSYNCDESTPATH
445 Copy folder to buildroot after installing all
446 RPMs.
447 Use together with --rsync-src. This is the path
448 on the
449 TARGET filesystem e.g.
450 /usr/src/packages/BUILD/linux-2.6 .
451 --rsync-src=RSYNCSRCPATH
452 Copy folder to buildroot after installing all
453 RPMs.
454 Use together with --rsync-dest. This is the path
455 on
456 the HOST filesystem e.g. /tmp/linux-kernel-tree.
457 It
458 defines RSYNCDONE 1 .
459 --no-changelog
460 don't update the package changelog from a
461 changes file
462 -l, --preload
463 Preload all files into the cache for offline op‐
464 eration
465 -o, --offline
466 Start with cached prjconf and packages without
467 contacting the api server
468 --clean Delete old build root before initializing it
469 buildconfig
473 Shows the build config
474 Shows the build configuration which is used in building a pack‐
476 age. This command is mostly used internally by the 'build' com‐
477 mand.
478 The returned data is the project-wide build configuration in a
480 format which is directly readable by the build script. It con‐
481 tains RPM macros and BuildRequires expansions, for example.
482 The argument REPOSITORY an be taken from the first column of the
484 'osc repos' output.
485 usage:
487 osc buildconfig REPOSITORY (in pkg or
488 prj dir)
489 osc buildconfig PROJECT REPOSITORY
490 buildhistory (buildhist)
493 Shows the build history of a package
494 The arguments REPOSITORY and ARCH can be taken from the first
496 two columns of the 'osc repos' output.
497 usage:
499 osc buildhist REPOSITORY ARCHITECTURE
500 osc buildhist PROJECT PACKAGE REPOSITORY ARCHITECTURE Op‐
501 tions:
502 -h, --help show this help message and exit
503 -M MPAC, --multibuild-package=MPAC
504 Show the buildhistory of the specified multi‐
505 build
506 package
507 -l limit, --limit=limit
508 for setting the number of results
509 --csv generate output in CSV (separated by |)
510 buildinfo
514 Shows the build info
515 Shows the build "info" which is used in building a package.
517 This command is mostly used internally by the 'build' subcom‐
518 mand. It needs to be called from within a package directory.
519 The BUILD_DESCR argument is optional. BUILD_DESCR is a local RPM
521 specfile or Debian "dsc" file. If specified, it is sent to the
522 server, and the buildinfo will be based on it. If the argument
523 is not supplied, the buildinfo is derived from the specfile
524 which is currently on the source repository server.
525 The returned data is XML and contains a list of the packages
527 used in building, their source, and the expanded BuildRequires.
528 The arguments REPOSITORY and ARCH are optional. They can be
530 taken from the first two columns of the 'osc repos' output. If
531 not specified, REPOSITORY defaults to the 'build_repository'
532 config entry in your 'oscrc' and ARCH defaults to your host ar‐
533 chitecture.
534 usage:
536 in a package working copy:
537 osc buildinfo [OPTS] REPOSITORY ARCH BUILD_DESCR
538 osc buildinfo [OPTS] REPOSITORY (ARCH = hostarch,
539 BUILD_DESCR is detected automatically)
540 osc buildinfo [OPTS] ARCH (REPOSITORY = build_repository
541 (config option), BUILD_DESCR is detected automatically)
542 osc buildinfo [OPTS] BUILD_DESCR (REPOSITORY =
543 build_repository (config option), ARCH = hostarch)
544 osc buildinfo [OPTS] (REPOSITORY = build_repository
545 (config option), ARCH = hostarch, BUILD_DESCR is detected auto‐
546 matically)
547 Note: if BUILD_DESCR does not exist locally the remote
548 BUILD_DESCR is used
549 osc buildinfo [OPTS] PROJECT PACKAGE REPOSITORY ARCH
551 [BUILD_DESCR]
552 Options:
554 -h, --help show this help message and exit
555 -p DIR, --prefer-pkgs=DIR
556 Prefer packages from this directory when in‐
557 stalling
558 the build-root
559 -x PAC, --extra-pkgs=PAC
560 Add this package when computing the buildinfo
561 -M MPAC, --multibuild-package=MPAC
562 Show the buildinfo of the specified multibuild
563 package
564 --alternative-project=PROJECT
565 specify the build target project
566 -d, --debug
567 verbose output of build dependencies
568 buildlog (bl, blt, buildlogtail)
572 Shows the build log of a package
573 Shows the log file of the build of a package. Can be used to
575 follow the log while it is being written. Needs to be called
576 from within a package directory.
577 When called as buildlogtail (or blt) it just shows the end of
579 the logfile. This is useful to see just a build failure rea‐
580 sons.
581 The arguments REPOSITORY and ARCH are the first two columns in
583 the 'osc results' output. If the buildlog url is used buildlog
584 command has the same behavior as remotebuildlog.
585 Usage:
587 osc buildlog [ARGS...]
588 [REPOSITORY ARCH | BUILDLOGURL] Options:
590 -h, --help show this help message and exit
591 -s, --strip-time
592 strip leading build time from the log
593 -o OFFSET, --offset=OFFSET
594 get log start or end from the offset
595 -M MPAC, --multibuild-package=MPAC
596 get log of the specified multibuild package
597 --lastsucceeded, --last-succeeded
598 Show the last succeeded log file
599 -l, --last Show the last finished log file
600 cat (blame, less)
604 Output the content of a file to standard output
605 Examples:
607 osc cat file
608 osc cat project package file
609 osc cat project/package/file
610 osc cat http://api.opensuse.org/build/.../_log
611 osc cat http://api.opensuse.org/source/../_link
612 osc less file
614 osc less project package file
615 osc blame file
617 osc blame project package file
618 Usage:
620 osc cat [ARGS...]
621 Options:
623 -h, --help show this help message and exit
624 -M, --meta list meta data files
625 -D, --deleted
626 access file in a deleted package
627 -u, --unexpand
628 always work with unexpanded packages.
629 -e, --expand
630 (default) force expansion of linked packages.
631 -r rev, --revision=rev
632 print out the specified revision
633 changedevelrequest (changedevelreq, cr)
637 Create request to change the devel package definition.
638 [See http://en.opensuse.org/openSUSE:Build_Service_Collaboration
640 for information on this topic.]
641 See the "request" command for showing and modifying existing re‐
643 quests.
644 osc changedevelrequest PROJECT PACKAGE DEVEL_PROJECT [DE‐
646 VEL_PACKAGE]
647 checkconstraints
650 check the constraints and view compliant workers
651 Checks the constraints for compliant workers.
653 usage:
655 remote request:
656 osc checkconstraints [OPTS] PROJECT PACKAGE REPOSITORY
657 ARCH
658 in a package working copy:
660 osc checkconstraints [OPTS] REPOSITORY ARCH CONSTRAINTS‐
661 FILE
662 osc checkconstraints [OPTS] CONSTRAINTSFILE
663 osc checkconstraints [OPTS]
664 Options:
666 -h, --help show this help message and exit
667 --ignore-file
668 ignore _constraints file and only check project
669 constraints
670 checkout (co)
674 Check out content from the repository
675 Check out content from the repository server, creating a local
677 working copy.
678 When checking out a single package, the option --revision can be
680 used to specify a revision of the package to be checked out.
681 When a package is a source link, then it will be checked out in
683 expanded form. If --unexpand-link option is used, the checkout
684 will instead produce the raw _link file plus patches.
685 usage:
687 osc co PROJECT [PACKAGE] [FILE]
688 osc co PROJECT # entire project
689 osc co PROJECT PACKAGE # a package
690 osc co PROJECT PACKAGE FILE # single file -> to
691 current dir
692 while inside a project directory:
694 osc co PACKAGE # check out PACKAGE
695 from project
696 with the result of rpm -q --qf '%{DISTURL}0 PACKAGE
698 osc co obs://API/PROJECT/PLATFORM/REVISION-PACKAGE
699 Options:
701 -h, --help show this help message and exit
702 -l limit_size, --limit-size=limit_size
703 Skip all files with a given size
704 -S, --server-side-source-service-files
705 Use server side generated sources instead of lo‐
706 cal
707 generation.
708 -s, --source-service-files
709 Run source services.
710 -o outdir, --output-dir=outdir
711 place package in the specified directory instead
712 of a
713 PROJECT/PACKAGE directory
714 -c, --current-dir
715 place PACKAGE folder in the current directory
716 instead
717 of a PROJECT/PACKAGE directory
718 -M, --meta checkout out meta data instead of sources
719 -u, --unexpand-link
720 if a package is a link, check out the _link file
721 instead of the expanded sources
722 -D, --deleted
723 checkout an already deleted package. No meta
724 information
725 -e, --expand-link
726 if a package is a link, check out the expanded
727 sources
728 (no-op, since this became the default)
729 -r rev, --revision=rev
730 checkout the specified revision. NOTE: if you
731 checkout
732 the complete project this option is ignored!
733 clean removes all untracked files from the package working copy
737 Examples:
739 osc clean <path>
740 Note: if <path> is omitted it defaults to '.' (<path> has to
742 be a package working copy)
743 Warning: This command removes all files with status '?'.
745 Usage:
747 osc clean [ARGS...]
748 Options:
750 -h, --help show this help message and exit
751 -n, --dry-run
752 print the results without actually removing a
753 file
754 cleanassets (ca)
758 Clean all previous downloaded assets.
759 This is useful to prepare a new git commit.
761 comment
764 List / create / delete comments
765 On create:
767 If -p is given a reply to the ID is created. Otherwise
768 a toplevel comment is created.
769 If -c is not given the default editor will be opened and
770 you can type your comment
771 usage:
773 osc comment list package PROJECT PACKAGE
774 osc comment list project PROJECT
775 osc comment list request REQUEST_ID
776 osc comment create [-p PARENT_ID] [-c COMMENT] package
778 PROJECT PACKAGE
779 osc comment create [-p PARENT_ID] [-c COMMENT] project
780 PROJECT
781 osc comment create [-p PARENT_ID] [-c COMMENT] request RE‐
782 QUEST_ID
783 osc comment delete ID
785 commit (checkin, ci)
789 Upload content to the repository server
790 Upload content which is changed in your working copy, to the
792 repository server.
793 examples:
795 osc ci # current dir
796 osc ci <dir>
797 osc ci file1 file2 ...
798 Usage:
800 osc commit [ARGS...]
801 Options:
803 -h, --help show this help message and exit
804 --skip-local-service-run, --noservice
805 Skip service run of configured source services
806 for
807 local run
808 -v, --verbose
809 Run the source services with verbose information
810 --skip-validation
811 deprecated, don't use it
812 -f, --force
813 force commit, even if there were no changes
814 -F FILE, --file=FILE
815 read log message from FILE, '-' denotes standard
816 input.
817 -n, --no-message
818 do not specify a log message
819 -m TEXT, --message=TEXT
820 specify log message TEXT
821 config get/set a config option
825 Examples:
827 osc config section option (get current value)
828 osc config section option value (set to value)
829 osc config section option --delete (delete option/reset to
830 the default)
831 osc config section --change-password (changes the password
832 in section "section")
833 (section is either an apiurl or an alias or 'general')
834 osc config --dump (dump the complete configuration)
835 Usage:
837 osc config [ARGS...]
838 Options:
840 -h, --help show this help message and exit
841 --dump-full
842 dump the complete configuration (including
843 'pass' and
844 'passx' options)
845 --dump dump the complete configuration (without 'pass'
846 and
847 'passx' options)
848 --no-echo prompt for a value but do not echo entered char‐
849 acters
850 --select-password-store
851 Change the password store
852 --change-password
853 Change password
854 -p, --prompt
855 prompt for a value
856 -s, --stdin
857 indicates that the config value should be read
858 from
859 stdin
860 -d, --delete
861 delete option from config or reset option to the
862 default)
863 copypac
867 Copy a package
868 A way to copy package to somewhere else.
870 It can be done across buildservice instances, if the -t option
872 is used. In that case, a client-side copy and link expansion
873 are implied.
874 Using --client-side-copy always involves downloading all files,
876 and uploading them to the target.
877 The DESTPAC name is optional; the source packages' name will be
879 used if DESTPAC is omitted.
880 usage:
882 osc copypac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC] Options:
883 -h, --help show this help message and exit
884 -e, --expand
885 if the source package is a link then copy the
886 expanded
887 version of the link
888 -m TEXT, --message=TEXT
889 specify message TEXT
890 -t URL, --to-apiurl=URL
891 URL of destination api server. Default is the
892 source
893 api server.
894 -r rev, --revision=rev
895 copy the specified revision.
896 -d, --keep-develproject
897 keep develproject tag in the package metadata
898 -K, --keep-link
899 If the target package is a link, the link is
900 kept, but
901 may be updated. If the source package is a link,
902 its
903 expanded version is considered.
904 -k, --keep-maintainers
905 keep original maintainers. Default is remove all
906 and
907 replace with the one calling the script.
908 -c, --client-side-copy
909 do a (slower) client-side copy
910 createincident
914 Create a maintenance incident
915 [See http://openbuildservice.org/help/manuals/obs-reference-
917 guide/cha.obs.maintenance_setup.html for information on this
918 topic.]
919 This command is asking to open an empty maintenance incident.
921 This can usually only be done by a responsible maintenance team.
922 Please see the "mbranch" command on how to full such a project
923 content and the "patchinfo" command how add the required mainte‐
924 nance update information.
925 usage:
927 osc createincident [ MAINTENANCEPROJECT ] Options:
928 -h, --help show this help message and exit
929 -m TEXT, --message=TEXT
930 specify message TEXT
931 --noaccess Create a hidden project
932 -a ATTRIBUTE, --attribute=ATTRIBUTE
933 Use this attribute to find default maintenance
934 project
935 (default is OBS:MaintenanceProject)
936 createrequest (creq)
940 create multiple requests with a single command
941 usage:
943 osc creq [OPTIONS] [
944 -a submit SOURCEPRJ SOURCEPKG DESTPRJ [DESTPKG]
945 -a delete PROJECT [PACKAGE]
946 -a change_devel PROJECT PACKAGE DEVEL_PROJECT [DE‐
947 VEL_PACKAGE]
948 -a add_me ROLE PROJECT [PACKAGE]
949 -a add_group GROUP ROLE PROJECT [PACKAGE]
950 -a add_role USER ROLE PROJECT [PACKAGE]
951 -a set_bugowner USER PROJECT [PACKAGE]
952 ]
953 Option -m works for all types of request, the rest work only
955 for submit. example:
956 osc creq -a submit -a delete home:someone:branches:open‐
957 SUSE:Tools -a change_devel openSUSE:Tools osc home:some‐
958 one:branches:openSUSE:Tools -m ok
959 This will submit all modified packages under current direc‐
961 tory, delete project home:someone:branches:openSUSE:Tools and
962 change the devel project to home:someone:branches:openSUSE:Tools
963 for package osc in project openSUSE:Tools. Options:
964 -h, --help show this help message and exit
965 --yes proceed without asking.
966 --no-update
967 never touch source package on accept (will break
968 source links)
969 --no-cleanup
970 never remove source package on accept, but up‐
971 date its
972 content
973 --cleanup remove package if submission gets accepted (de‐
974 fault
975 for home:<id>:branch projects)
976 --nodevelproject
977 do not follow a defined devel project (primary
978 project
979 where a package is developed)
980 -s REQUEST_ID, --supersede=REQUEST_ID
981 Superseding another request by this one
982 -r REV, --revision=REV
983 for "create", specify a certain source revision
984 ID
985 (the md5 sum)
986 -m TEXT, --message=TEXT
987 specify message TEXT
988 -a, --action
989 specify action type of a request, can be :
990 submit/delete/change_devel/add_role/set_bugowner
991 delete (del, remove, rm)
995 Mark files or package directories to be deleted upon the next
996 'checkin'
997 usage:
999 cd .../PROJECT/PACKAGE
1000 osc delete FILE [...]
1001 cd .../PROJECT
1002 osc delete PACKAGE [...]
1003 This command works on check out copies. Use "rdelete" for work‐
1005 ing on server side only. This is needed for removing the entire
1006 project.
1007 As a safety measure, projects must be empty (i.e., you need to
1009 delete all packages first).
1010 If you are sure that you want to remove a package and all its
1012 files use '--force' switch. Sometimes this also works without
1013 --force.
1014 Options:
1016 -h, --help show this help message and exit
1017 -f, --force
1018 forces removal of entire package and its files
1019 deleterequest (deletereq, dr, dropreq, droprequest)
1023 Request to delete (or 'drop') a package or project
1024 usage:
1026 osc deletereq [-m TEXT] # works in
1027 checked out project/package
1028 osc deletereq [-m TEXT] PROJECT PACKAGE
1029 osc deletereq [-m TEXT] PROJECT [--all|--repository REPOSI‐
1030 TORY] Options:
1031 -h, --help show this help message and exit
1032 --accept-in-hours=HOURS
1033 specify time when request shall get accepted
1034 automatically. Only works with write permissions
1035 in
1036 target.
1037 --all deletes entire project with packages inside
1038 -r REPOSITORY, --repository=REPOSITORY
1039 specify repository
1040 -m TEXT, --message=TEXT
1041 specify message TEXT
1042 dependson
1046 dependson shows the build dependencies inside of a project,
1047 valid for a given repository and architecture.
1048 The command can be used to find build dependencies (wrt. a given
1050 repository and arch) that reside in the same project. To see all
1051 build dependencies use the buildinfo command.
1052 This is no guarantee, since the new build might have changed de‐
1054 pendencies.
1055 NOTE: to see all binary packages, which can trigger a build you
1057 need to
1058 refer the buildinfo, since this command shows only the de‐
1059 pendencies
1060 inside of a project.
1061 The arguments REPOSITORY and ARCH can be taken from the first
1063 two columns of the 'osc repos' output.
1064 usage in package or project directory:
1066 osc dependson REPOSITORY ARCH
1067 usage:
1069 osc dependson PROJECT [PACKAGE] REPOSITORY ARCH
1070 detachbranch
1074 replace a link with its expanded sources
1075 If a package is a link it is replaced with its expanded sources.
1077 The link does not exist anymore.
1078 usage:
1080 osc detachbranch # can be used in package
1081 working copy
1082 osc detachbranch PROJECT PACKAGE Options:
1083 -h, --help show this help message and exit
1084 -m TEXT, --message=TEXT
1085 specify message TEXT
1086 develproject (bsdevelproject, dp)
1090 print the devel project / package of a package
1091 Examples:
1093 osc develproject PRJ PKG
1094 osc develproject Options:
1095 -h, --help show this help message and exit
1096 -r, --raw deprecated option
1097 diff (di, ldiff, linkdiff)
1101 Generates a diff
1102 Generates a diff, comparing local changes against the repository
1104 server.
1105 Usage:
1107 osc diff [ARGS...]
1108 ARG, if specified, is a filename to include in the diff.
1110 Default: all files.
1111 osc diff --link
1113 osc linkdiff
1114 Compare current checkout directory against the link
1115 base.
1116 osc diff --link PROJ PACK
1118 osc linkdiff PROJ PACK
1119 Compare a package against the link base (ignoring work‐
1120 ing copy changes).
1121 Options:
1123 -h, --help show this help message and exit
1124 -u, --unexpand
1125 Local changes only, ignore changes in linked
1126 package
1127 sources
1128 --missingok
1129 do not fail if the source or target
1130 project/package
1131 does not exist on the server
1132 -l, --link (osc linkdiff): compare against the base revi‐
1133 sion of
1134 the link
1135 -p, --plain
1136 output the diff in plain (not unified) diff for‐
1137 mat
1138 -M, --meta operate on meta files
1139 -r rev1[:rev2], --revision=rev1[:rev2]
1140 If rev1 is specified it will compare your work‐
1141 ing copy
1142 against the revision (rev1) on the server. If
1143 rev1 and
1144 rev2 are specified it will compare rev1 against
1145 rev2
1146 (NOTE: changes in your working copy are ignored
1147 in
1148 this case)
1149 -c rev, --change=rev
1150 the change made by revision rev (like -r
1151 rev-1:rev).If
1152 rev is negative this is like -r rev:rev-1.
1153 distributions (dists)
1157 Shows all available distributions
1158 This command shows the available distributions. For active dis‐
1160 tributions it shows the name, project and name of the repository
1161 and a suggested default repository name.
1162 usage:
1164 osc distributions
1165 downloadassets (da)
1169 Download all assets referenced in the build descriptions
1170 enablechannels (enablechannel)
1173 Enables channels
1174 Enables existing channel packages in a project. Enabling means
1176 adding the needed repositories for building. The command can be
1177 used to enable a specific one or all channels of a project.
1178 Examples:
1180 osc enablechannels [PROJECT [CHANNEL_PACKAGE]]
1181 getbinaries
1184 Download binaries to a local directory
1185 This command downloads packages directly from the api server.
1187 Thus, it directly accesses the packages that are used for build‐
1188 ing others even when they are not "published" yet.
1189 usage:
1191 osc getbinaries REPOSITORY #
1192 works in checked out project/package (check out all archs in
1193 subdirs)
1194 osc getbinaries REPOSITORY ARCHITECTURE #
1195 works in checked out project/package
1196 osc getbinaries PROJECT REPOSITORY ARCHITECTURE
1197 osc getbinaries PROJECT PACKAGE REPOSITORY ARCHITECTURE
1198 osc getbinaries PROJECT PACKAGE REPOSITORY ARCHITECTURE FILE
1199 Options:
1200 -h, --help show this help message and exit
1201 --ccache allow fetching ccache archive
1202 --debug also fetch debug packages
1203 --sources also fetch source packages
1204 -M FLAVOR, --multibuild-package=FLAVOR
1205 Get binaries from the specified flavor of a
1206 multibuild
1207 package. It is meant for use from a package
1208 checkout
1209 when it is not possible to specify package:fla‐
1210 vor.
1211 -d DIR, --destdir=DIR
1212 destination directory
1213 -q, --quiet
1214 do not show downloading progress
1215 help (?, h)
1219 give detailed help on a specific sub-command
1220 usage:
1222 osc help [SUBCOMMAND]
1223 importsrcpkg
1226 Import a new package from a src.rpm
1227 A new package dir will be created inside the project dir (if no
1229 project is specified and the current working dir is a project
1230 dir the package will be created in this project). If the package
1231 does not exist on the server it will be created too otherwise
1232 the meta data of the existing package will be updated (<title />
1233 and <description />). The src.rpm will be extracted into the
1234 package dir. The files won't be committed unless you explicitly
1235 pass the --commit switch.
1236 SRPM is the path of the src.rpm in the local filesystem, or an
1238 URL.
1239 Usage:
1241 osc importsrcpkg SRPM
1242 Options:
1244 -h, --help show this help message and exit
1245 -c, --commit
1246 commit the new files
1247 --delete-old-files
1248 delete existing files from the server
1249 -d description, --description=description
1250 set the description of the package
1251 -t title, --title=title
1252 set a title
1253 -n name, --name=name
1254 specify a package name
1255 -p project, --project=project
1256 specify the path to a project
1257 info Print information about a working copy
1261 Print information about each ARG (default: '.') ARG is a work‐
1263 ing-copy path.
1264 Usage:
1266 osc info [ARGS...]
1267 init Initialize a directory as working copy
1271 Initialize an existing directory to be a working copy of an (al‐
1273 ready existing) buildservice project/package.
1274 (This is the same as checking out a package and then copying
1276 sources into the directory. It does NOT create a new package. To
1277 create a package, use 'osc meta pkg ... ...')
1278 You wouldn't normally use this command.
1280 To get a working copy of a package (e.g. for building it or
1282 working on it, you would normally use the checkout command. Use
1283 "osc help checkout" to get help for it.
1284 usage:
1286 osc init PRJ
1287 osc init PRJ PAC
1288 osc init PRJ PAC SCM_URL
1289 jobhistory (jobhist)
1292 Shows the job history of a project
1293 The arguments REPOSITORY and ARCH can be taken from the first
1295 two columns of the 'osc repos' output.
1296 usage:
1298 osc jobhist REPOSITORY ARCHITECTURE (in project dir)
1299 osc jobhist PROJECT [PACKAGE] REPOSITORY ARCHITECTURE Op‐
1300 tions:
1301 -h, --help show this help message and exit
1302 -M MPAC, --multibuild-package=MPAC
1303 get jobhistory for the specified multibuild
1304 package
1305 -l limit, --limit=limit
1306 for setting the number of results
1307 --csv generate output in CSV (separated by |)
1308 linkpac
1312 "Link" a package to another package
1313 A linked package is a clone of another package, but plus local
1315 modifications. It can be cross-project.
1316 The DESTPAC name is optional; the source packages' name will be
1318 used if DESTPAC is omitted.
1319 Afterwards, you will want to 'checkout DESTPRJ DESTPAC'.
1321 To add a patch, add the patch as file and add it to the _link
1323 file. You can also specify text which will be inserted at the
1324 top of the spec file.
1325 See the examples in the _link file.
1327 NOTE: In case you want to fix or update another package, you
1329 should use the 'branch'
1330 command. A branch has correct repositories (and a link)
1331 setup up by default and
1332 will be cleaned up automatically after it was submitted
1333 back.
1334 usage:
1336 osc linkpac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC] Options:
1337 -h, --help show this help message and exit
1338 -N, --new-package
1339 create a link to a not yet existing package
1340 -d, --disable-publish
1341 disable publishing of the linked package
1342 -f, --force
1343 overwrite an existing link file if it is there.
1344 -r rev, --revision=rev
1345 link the specified revision.
1346 -c, --current
1347 link fixed against current revision.
1348 -C CICOUNT, --cicount=CICOUNT
1349 cicount attribute in the link, known values are
1350 add,
1351 copy, and local, default in buildservice is cur‐
1352 rently
1353 add.
1354 linktobranch
1358 Convert a package containing a classic link with patch to a
1359 branch
1360 This command tells the server to convert a _link with or without
1362 a project.diff to a branch. This is a full copy with a _link
1363 file pointing to the branched place.
1364 usage:
1366 osc linktobranch # can be used in checked
1367 out package
1368 osc linktobranch PROJECT PACKAGE
1369 list (LL, lL, ll, ls)
1372 List sources or binaries on the server
1373 Examples for listing sources:
1375 ls # list all projects (deprecated)
1376 ls / # list all projects
1377 ls . # take PROJECT/PACKAGE from cur‐
1378 rent dir.
1379 ls PROJECT # list packages in a project
1380 ls PROJECT PACKAGE # list source files of package of
1381 a project
1382 ls PROJECT PACKAGE <file> # list <file> if this file exists
1383 ls -v PROJECT PACKAGE # verbosely list source files of
1384 package
1385 ls -l PROJECT PACKAGE # verbosely list source files of
1386 package
1387 ll PROJECT PACKAGE # verbosely list source files of
1388 package
1389 LL PROJECT PACKAGE # verbosely list source files of
1390 expanded link
1391 With --verbose, the following fields will be shown for each
1393 item:
1394 MD5 hash of file
1395 Revision number of the last commit
1396 Size (in bytes)
1397 Date and time of the last commit
1398 Examples for listing binaries:
1400 ls -b PROJECT # list all binaries of a project
1401 ls -b PROJECT -a ARCH # list ARCH binaries of a project
1402 ls -b PROJECT -r REPO # list binaries in REPO
1403 ls -b PROJECT PACKAGE REPO ARCH
1404 Usage:
1406 list (LL, lL, ll, ls) [PROJECT [PACKAGE]]
1407 list (LL, lL, ll, ls) -b [PROJECT [PACKAGE [REPO [ARCH]]]]
1408 Options:
1409 -h, --help show this help message and exit
1410 -R REVISION, --revision=REVISION
1411 specify revision (only for sources)
1412 -M, --meta list meta data files
1413 -D, --deleted
1414 show only the former deleted projects or pack‐
1415 ages
1416 -l, --long print extra information
1417 -v, --verbose
1418 print extra information
1419 -u, --unexpand
1420 always work with unexpanded (source) packages
1421 -e, --expand
1422 expand linked package (only for sources)
1423 -b, --binaries
1424 list built binaries instead of sources
1425 -r REPO, --repo=REPO
1426 specify repository (only for binaries)
1427 -a ARCH, --arch=ARCH
1428 specify architecture (only for binaries)
1429 localbuildlog (lbl)
1433 Shows the build log of a local buildchroot
1434 usage:
1436 osc lbl [REPOSITORY [ARCH]]
1437 osc lbl # show log of newest last local build
1438 Options:
1440 -h, --help show this help message and exit
1441 -s, --strip-time
1442 strip leading build time from the log
1443 -o OFFSET, --offset=OFFSET
1444 get log starting from offset
1445 lock Locks a project or package.
1449 usage:
1451 osc lock PROJECT [PACKAGE]
1452 Options:
1454 -h, --help show this help message and exit
1455 -m TEXT, --message=TEXT
1456 specify log message TEXT
1457 log Shows the commit log of a package
1461 Usage:
1463 osc log (inside working copy)
1464 osc log remote_project [remote_package]
1465 Options:
1467 -h, --help show this help message and exit
1468 -M, --meta checkout out meta data instead of sources
1469 -D, --deleted
1470 work on deleted package
1471 --xml generate output in XML
1472 --csv generate output in CSV (separated by |)
1473 -r rev, --revision=rev
1474 show log of the specified revision
1475 maintainer (bugowner)
1479 Show maintainers according to server side configuration
1480 # Search for official maintained sources in OBS instance
1482 osc maintainer BINARY_OR_PACKAGE_NAME <options>
1483 osc maintainer -U <user> <options>
1484 osc maintainer -G <group> <options>
1485 # Lookup via containers
1487 osc maintainer <options>
1488 osc maintainer PRJ <options>
1489 osc maintainer PRJ PKG <options>
1490 The tool looks up the default responsible person for a certain
1492 project or package. When using with an OBS 2.4 (or later)
1493 server it is doing the lookup for a given binary according to
1494 the server side configuration of default owners.
1495 The tool is also looking into devel packages and supports to
1497 fallback to the project in case a package has no defined main‐
1498 tainer.
1499 Please use "osc meta pkg" in case you need to know the defini‐
1501 tion in a specific container.
1502 PRJ and PKG default to current working-copy path.
1504 Usage:
1506 osc maintainer [ARGS...]
1507 Options:
1509 -h, --help show this help message and exit
1510 -m MESSAGE, --message=MESSAGE
1511 Define message as commit entry or request de‐
1512 scription
1513 -r role, --role=role
1514 Specify user role
1515 -d user, --delete=user
1516 delete a maintainer/bugowner (can be specified
1517 via
1518 --role)
1519 -G GROUP, --group=GROUP
1520 All official maintained instances for the speci‐
1521 fied
1522 GROUP
1523 -U USER, --user=USER
1524 All official maintained instances for the speci‐
1525 fied
1526 USER
1527 -S user, --set-bugowner-request=user
1528 Set the bugowner to specified person via a re‐
1529 quest (or
1530 group via group: prefix)
1531 -s user, --set-bugowner=user
1532 Set the bugowner to specified person (or group
1533 via
1534 group: prefix)
1535 -A, --all list all found entries not just the first one
1536 -a user, --add=user
1537 add a new person for given role ("maintainer" by
1538 default)
1539 -D devel_project, --devel-project=devel_project
1540 define the project where this package is primar‐
1541 ily
1542 developed
1543 -v, --verbose
1544 show more information
1545 --nodevelproject
1546 do not follow a defined devel project (primary
1547 project
1548 where a package is developed)
1549 -e, --email
1550 show email addresses instead of user names
1551 -B, --bugowner
1552 Show only the bugowner if defined, or maintainer
1553 otherwise
1554 -b, --bugowner-only
1555 Show only the bugowner
1556 maintenancerequest (mr)
1560 Create a request for starting a maintenance incident.
1561 [See http://openbuildservice.org/help/manuals/obs-reference-
1563 guide/cha.obs.maintenance_setup.html for information on this
1564 topic.]
1565 This command is asking the maintenance team to start a mainte‐
1567 nance incident based on a created maintenance update. Please see
1568 the "mbranch" command on how to create such a project and the
1569 "patchinfo" command how add the required maintenance update in‐
1570 formation.
1571 usage:
1573 osc maintenancerequest [ SOURCEPROJECT [ SOURCEPACKAGES RE‐
1574 LEASEPROJECT ] ]
1575 osc maintenancerequest .
1576 The 2nd line when issued within a package directory provides a
1578 short cut to submit a single package (the one in the current di‐
1579 rectory) from the project of this package to be submitted to the
1580 release project this package links to. This syntax is only valid
1581 when specified from a package subdirectory. Options:
1582 -h, --help show this help message and exit
1583 -s REQUEST_ID, --supersede=REQUEST_ID
1584 Superseding another request by this one
1585 --incident-project=INCIDENT_PROJECT
1586 specify incident project to merge in
1587 --incident=INCIDENT
1588 specify incident number to merge in
1589 --cleanup do remove source project on accept
1590 --no-cleanup
1591 do not remove source project on accept
1592 --enforce-branching
1593 submit from a fresh branched project
1594 --release-project=RELEASEPROJECT
1595 Specify the release project
1596 -m TEXT, --message=TEXT
1597 specify message TEXT
1598 -a ATTRIBUTE, --attribute=ATTRIBUTE
1599 Use this attribute to find default maintenance
1600 project
1601 (default is OBS:MaintenanceProject)
1602 man generates a man page
1606 usage:
1608 osc man
1609 mbranch (maintained, sm)
1612 Search or branch multiple instances of a package
1613 This command is used for searching all relevant instances of
1615 packages and creating links of them in one project. This is
1616 esp. used for maintenance updates. It can also be used to branch
1617 all packages marked before with a given attribute.
1618 [See http://en.opensuse.org/openSUSE:Build_Service_Concept_Main‐
1620 tenance for information on this topic.]
1621 The branched package will live in
1623 home:USERNAME:branches:ATTRIBUTE:PACKAGE if nothing else
1624 specified.
1625 If osc maintained or sm is issued only the relevant instances of
1627 a package will be shown. No branch will be created. This is sim‐
1628 ilar to osc mbranch --dryrun.
1629 usage:
1631 osc sm [SOURCEPACKAGE] [-a ATTRIBUTE]
1632 osc mbranch [ SOURCEPACKAGE [ TARGETPROJECT ] ] Options:
1633 -h, --help show this help message and exit
1634 --version print version of maintained package
1635 --nodevelproject
1636 do not follow a defined devel project (primary
1637 project
1638 where a package is developed)
1639 --noaccess Create a hidden project
1640 --dryrun Just simulate the action and report back the re‐
1641 sult.
1642 -u UPDATE_ATTRIBUTE, --update-project-attribute=UPDATE_AT‐
1643 TRIBUTE
1644 Use this attribute to find update projects (de‐
1645 fault is
1646 OBS:UpdateProject)
1647 -a ATTRIBUTE, --attribute=ATTRIBUTE
1648 Use this attribute to find affected packages
1649 (default
1650 is OBS:Maintained)
1651 -c, --checkout
1652 Checkout branched package afterwards ('osc bco'
1653 is a
1654 shorthand for this option)
1655 meta Show meta information, or edit it
1659 Show or edit build service metadata of type <prj|pkg|prj‐
1661 conf|user|pattern>.
1662 This command displays metadata on buildservice objects like
1664 projects, packages, or users. The type of metadata is specified
1665 by the word after "meta", like e.g. "meta prj".
1666 prj denotes metadata of a buildservice project. prjconf denotes
1668 the (build) configuration of a project. pkg denotes metadata of
1669 a buildservice package. user denotes the metadata of a user.
1670 group denotes the metadata of a group. pattern denotes instal‐
1671 lation patterns defined for a project.
1672 To list patterns, use 'osc meta pattern PRJ'. An additional ar‐
1674 gument will be the pattern file to view or edit.
1675 With the --edit switch, the metadata can be edited. Per default,
1677 osc opens the program specified by the environmental variable
1678 EDITOR with a temporary file. Alternatively, content to be saved
1679 can be supplied via the --file switch. If the argument is '-',
1680 input is taken from stdin: osc meta prjconf home:user | sed ...
1681 | osc meta prjconf home:user -F -
1682 For meta prj and prjconf updates optional commit messages can be
1684 applied with --message.
1685 When trying to edit a non-existing resource, it is created im‐
1687 plicitly.
1688 Examples:
1691 osc meta prj PRJ
1692 osc meta pkg PRJ PKG
1693 osc meta pkg PRJ PKG -e
1694 Usage:
1696 osc meta <prj|prjconf> [-r|--revision REV] ARGS...
1697 osc meta <prj|pkg|prjconf|user|group|pattern> ARGS...
1698 osc meta <prj|pkg|prjconf|user|group|pattern> [-m|--message
1699 TEXT] -e|--edit ARGS...
1700 osc meta <prj|pkg|prjconf|user|group|pattern> [-m|--message
1701 TEXT] -F|--file ARGS...
1702 osc meta pattern --delete PRJ PATTERN
1703 osc meta attribute PRJ [PKG [SUBPACKAGE]] [--attribute AT‐
1704 TRIBUTE] [--create [--set <value_list>]|--delete|--set
1705 <value_list>] Options:
1706 -h, --help show this help message and exit
1707 --delete delete a pattern or attribute
1708 -s ATTRIBUTE_VALUES, --set=ATTRIBUTE_VALUES
1709 set attribute values
1710 -R, --remove-linking-repositories
1711 Try to remove also all repositories building
1712 against
1713 remove ones.
1714 -c, --create
1715 create attribute without values
1716 -e, --edit edit metadata
1717 -m TEXT, --message=TEXT
1718 specify log message TEXT. For prj and prjconf
1719 meta
1720 only
1721 -r REV, --revision=REV
1722 checkout given revision instead of head revi‐
1723 sion. For
1724 prj and prjconf meta only
1725 -F FILE, --file=FILE
1726 read metadata from FILE, instead of opening an
1727 editor.
1728 '-' denotes standard input.
1729 -f, --force
1730 force the save operation, allows one to ignores
1731 some
1732 errors like depending repositories. For prj meta
1733 only.
1734 --blame show author and time of each line
1735 --attribute-project
1736 include project values, if missing in packages
1737 --attribute-defaults
1738 include defined attribute defaults
1739 -a ATTRIBUTE, --attribute=ATTRIBUTE
1740 affect only a given attribute
1741 mkpac Create a new package under version control
1745 usage:
1747 osc mkpac new_package
1748 mv Move SOURCE file to DEST and keep it under version control
1751 Usage:
1753 osc mv SOURCE DEST
1754 Options:
1756 -h, --help show this help message and exit
1757 -f, --force
1758 forces removal of entire package and its files
1759 my show waiting work, packages, projects or requests involving
1763 yourself
1764 Examples:
1766 # list all open tasks for me
1767 osc my [work]
1768 # list packages where I am bugowner
1769 osc my pkg -b
1770 # list projects where I am maintainer
1771 osc my prj -m
1772 # list request for all my projects and packages
1773 osc my rq
1774 # list requests, excluding project 'foo' and 'bar'
1775 osc my rq --exclude-project foo,bar
1776 # list requests I made
1777 osc my sr
1778 Usage:
1780 osc my [ARGS...]
1781 where TYPE is one of requests, submitrequests,
1783 projects or packages (rq, sr, prj or pkg)
1784 Options:
1786 -h, --help
1787 show this help message and exit
1788 --maintained
1789 limit search results to packages with maintained
1790 attribute set.
1791 -v, --verbose
1792 verbose listing
1793 --exclude-project=EXCLUDE_PROJECT
1794 exclude requests for specified project
1795 -U USER, --user=USER
1796 search for USER instead of yourself
1797 -a, --all
1798 all involvements
1799 -m, --maintainer
1800 restrict listing to items where the user is
1801 maintainer
1802 -b, --bugowner
1803 restrict listing to items where the user is bu‐
1804 gowner
1805 patchinfo
1809 Generate and edit a patchinfo file.
1810 A patchinfo file describes the packages for an update and the
1812 kind of problem it solves.
1813 This command either creates a new _patchinfo or updates an ex‐
1815 isting one.
1816 Examples:
1818 osc patchinfo
1819 osc patchinfo [PROJECT [PATCH_NAME]] Options:
1820 -h, --help show this help message and exit
1821 -f, --force
1822 force generation of new patchinfo file, do not
1823 update
1824 existing one.
1825 pdiff Quick alias to diff the content of a package with its parent.
1829 Usage:
1831 osc pdiff [--plain|-p] [--nomissing-ok|-n]
1832 osc pdiff [--plain|-p] [--nomissing-ok|-n] PKG
1833 osc pdiff [--plain|-p] [--nomissing-ok|-n] PRJ PKG
1834 Options:
1836 -h, --help show this help message and exit
1837 -n, --nomissingok
1838 fail if the parent package does not exist on the
1839 server
1840 -p, --plain
1841 output the diff in plain (not unified) diff for‐
1842 mat
1843 prdiff (projdiff, projectdiff)
1847 Server-side diff of two projects
1848 Compares two projects and either summarizes or outputs the dif‐
1850 ferences in full. In the second form, a project is compared
1851 with one of its branches inside a home:$USER project (the branch
1852 is treated as NEWPRJ). The home branch is optional if the cur‐
1853 rent working directory is a checked out copy of it.
1854 Usage:
1856 osc prdiff [OPTIONS] OLDPRJ NEWPRJ
1857 osc prdiff [OPTIONS] [home:$USER:branch:$PRJ]
1858 Options:
1860 -h, --help show this help message and exit
1861 -d, --diffstat
1862 show diffstat of differences
1863 -u, --unified
1864 show full unified diffs of differences
1865 -o, --show-not-in-new
1866 show packages only in the old project
1867 -n, --show-not-in-old
1868 show packages only in the new project
1869 -i REGEXP, --include=REGEXP
1870 only consider packages matching REGEXP
1871 -e REGEXP, --exclude=REGEXP
1872 skip packages matching REGEXP
1873 -r, --requests
1874 show open requests for any packages with differ‐
1875 ences
1876 prjresults (pr)
1880 Shows project-wide build results
1881 Usage:
1883 osc prjresults (inside working copy)
1884 osc prjresults PROJECT
1885 Options:
1887 -h, --help show this help message and exit
1888 --show-excluded
1889 show packages that are excluded in all repos,
1890 also
1891 hide repos that have only excluded packages
1892 -V, --vertical
1893 list packages vertically instead horizontally
1894 -r REPO, --repo=REPO
1895 show results only for specified repo(s)
1896 -a ARCH, --arch=ARCH
1897 show results only for specified architecture(s)
1898 -n EXPR, --name-filter=EXPR
1899 show only packages whose names match EXPR
1900 -s STATUS, --status-filter=STATUS
1901 show only packages with buildstatus STATUS (see
1902 legend)
1903 --xml generate output in XML
1904 -c, --csv csv output
1905 -w, --watch
1906 watch the results until all finished building,
1907 only
1908 supported with --xml
1909 -b, --brief
1910 show the result in "pkgname repo arch result"
1911 -q, --hide-legend
1912 hide the legend
1913 pull merge the changes of the link target into your working copy.
1917 rdelete
1921 Delete a project or packages on the server.
1922 As a safety measure, project must be empty (i.e., you need to
1924 delete all packages first). Also, packages must have no requests
1925 pending (i.e., you need to accept/revoke such requests first).
1926 If you are sure that you want to remove this project and all its
1927 packages use '--recursive' switch. It may still not work be‐
1928 cause other depends on it. If you want to ignore this as well
1929 use '--force' switch.
1930 usage:
1932 osc rdelete [-r] [-f] PROJECT [PACKAGE]
1933 Options:
1935 -h, --help show this help message and exit
1936 -m TEXT, --message=TEXT
1937 specify log message TEXT
1938 -f, --force
1939 deletes a project where other depends on
1940 -r, --recursive
1941 deletes a project with packages inside
1942 rdiff Server-side "pretty" diff of two packages
1946 Compares two packages (three or four arguments) or shows the
1948 changes of a specified revision of a package (two arguments)
1949 If no revision is specified the latest revision is used.
1951 usage:
1953 osc rdiff OLDPRJ OLDPAC NEWPRJ [NEWPAC]
1954 osc rdiff PROJECT PACKAGE Options:
1955 -h, --help show this help message and exit
1956 --xml show diff as xml (only for issues diff)
1957 -u, --unexpand
1958 diff unexpanded version if sources are linked
1959 --missingok
1960 do not fail if the source or target
1961 project/package
1962 does not exist on the server
1963 -c rev, --change=rev
1964 the change made by revision rev (like -r
1965 rev-1:rev).
1966 If rev is negative this is like -r rev:rev-1.
1967 -p, --plain
1968 output the diff in plain (not unified) diff for‐
1969 mat and
1970 show diff of files in archives
1971 -r N[:M], --revision=N[:M]
1972 revision id, where N = old revision and M = new
1973 revision
1974 -M, --meta diff meta data
1975 --issues-only
1976 show only issues in diff
1977 --oldpkg=OLDPKG
1978 package to compare against (deprecated, use 3
1979 argument
1980 form)
1981 --oldprj=OLDPRJ
1982 project to compare against (deprecated, use 3
1983 argument
1984 form)
1985 rebuild (rebuildpac)
1989 Trigger package rebuilds
1990 Note that it is normally NOT needed to kick off rebuilds like
1992 this, because they principally happen in a fully automatic way,
1993 triggered by source check-ins. In particular, the order in which
1994 packages are built is handled by the build service.
1995 The arguments REPOSITORY and ARCH can be taken from the first
1997 two columns of the 'osc repos' output.
1998 usage:
2000 osc rebuild [PROJECT [PACKAGE [REPOSITORY [ARCH]]]] Options:
2001 -h, --help show this help message and exit
2002 --all Rebuild all packages of entire project
2003 -M MULTIBUILD_PACKAGE, --multibuild-package=MULTIBUILD_PACK‐
2004 AGE
2005 rebuild specified multibuild package
2006 -f, --failed
2007 rebuild all failed packages
2008 -r REPO, --repo=REPO
2009 trigger rebuilds for a specific repository
2010 -a ARCH, --arch=ARCH
2011 trigger rebuilds for a specific architecture
2012 release
2016 Release sources and binaries
2017 This command is used to transfer sources and binaries without
2019 rebuilding them. It requires defined release targets set to
2020 trigger="manual".
2021 usage:
2023 osc release [ SOURCEPROJECT [ SOURCEPACKAGE ] ]
2024 Options:
2026 -h, --help show this help message and exit
2027 --no-delay Don't put the release job in a queue to be run
2028 later,
2029 but immediately run it. Thus the next call to
2030 osc
2031 prjresult will reflect it. Otherwise there is no
2032 way
2033 to know if it is finished or didn't start yet.
2034 --set-release=RELEASETAG
2035 rename binaries during release using this re‐
2036 lease tag
2037 --target-repository=TARGETREPOSITORY
2038 Release only to specified repository
2039 --target-project=TARGETPROJECT
2040 Release only to specified project
2041 -r REPO, --repo=REPO
2042 Release only binaries from the specified reposi‐
2043 tory
2044 releaserequest
2048 Create a release request
2049 For maintenance incident projects:
2051 This command is used by the maintenance team to start the re‐
2053 lease process of a maintenance update. This includes usually
2054 testing based on the defined reviewers of the update project.
2055 [See https://openbuildservice.org/help/manuals/obs-user-
2057 guide/cha.obs.maintenance_setup.html
2058 for information on this topic.]
2059 For normal projects:
2061 This command is used to transfer sources and binaries without
2063 rebuilding them. It requires defined release targets set to
2064 trigger="manual".
2065 [See https://openbuildservice.org/help/manuals/obs-user-
2067 guide/cha.obs.request_and_review_system.html
2068 for information on this topic.]
2069 usage:
2071 osc releaserequest [-p package] [ SOURCEPROJECT ]
2072 Options:
2074 -h, --help show this help message and exit
2075 -p PKG, --package=PKG
2076 specify packages to release
2077 -m TEXT, --message=TEXT
2078 specify message TEXT
2079 remotebuildlog (rbl, rblt, rbuildlog, rbuildlogtail, remotebuildlog‐
2083 tail)
2084 Shows the build log of a package
2085 Shows the log file of the build of a package. Can be used to
2087 follow the log while it is being written.
2088 remotebuildlogtail shows just the tail of the log file.
2090 usage:
2092 osc remotebuildlog project package repository arch
2093 or
2094 osc remotebuildlog project/package/repository/arch
2095 or
2096 osc remotebuildlog buildlogurl Options:
2097 -h, --help show this help message and exit
2098 -s, --strip-time
2099 strip leading build time from the log
2100 -o OFFSET, --offset=OFFSET
2101 get log starting or ending from the offset
2102 -M MPAC, --multibuild-package=MPAC
2103 show log file for specified multibuild package
2104 --lastsucceeded, --last-succeeded
2105 Show the last succeeded log file
2106 -l, --last Show the last finished log file
2107 repairlink
2111 Repair a broken source link
2112 This command checks out a package with merged source changes. It
2114 uses a 3-way merge to resolve file conflicts. After review‐
2115 ing/repairing the merge, use 'osc resolved ...' and 'osc ci' to
2116 re-create a working source link.
2117 usage: * For merging conflicting changes of a checkout package:
2119 osc repairlink
2120 * Check out a package and merge changes:
2122 osc repairlink PROJECT PACKAGE
2123 * Pull conflicting changes from one project into another one:
2125 osc repairlink PROJECT PACKAGE INTO_PROJECT [INTO_PACKAGE]
2126 Options:
2128 -h, --help show this help message and exit
2129 -d DIR, --destdir=DIR
2130 destination directory
2131 repairwc
2135 try to repair an inconsistent working copy
2136 Examples:
2138 osc repairwc <path>
2139 Note: if <path> is omitted it defaults to '.' (<path> can be
2141 a project or package working copy)
2142 Warning: This command might delete some files in the storedir
2144 (.osc). Please check the state of the wc afterwards (via 'osc
2145 status').
2146 Usage:
2148 osc repairwc [ARGS...]
2149 Options:
2151 -h, --help show this help message and exit
2152 --force-apiurl
2153 ask once for an apiurl and force this apiurl for
2154 all
2155 inconsistent projects/packages
2156 repositories (platforms, repos)
2160 shows repositories configured for a project.
2161 It skips repositories by default which are dis‐
2162 abled for a given package.
2163 usage:
2165 osc repos
2166 osc repos [PROJECT] [PACKAGE]
2167 repourls
2171 Shows URLs of .repo files
2172 Shows URLs on which to access the project repositories.
2174 usage:
2176 osc repourls [PROJECT]
2177 request (review, rq)
2181 Show or modify requests and reviews
2182 [See http://en.opensuse.org/openSUSE:Build_Service_Collaboration
2184 for information on this topic.]
2185 The 'request' command has the following sub commands:
2187 "list" lists open requests attached to a project or package or
2189 person. Uses the project/package of the current directory if
2190 none of -M, -U USER, project/package are given.
2191 "log" will show the history of the given ID
2193 "show" will show the request itself, and generate a diff for re‐
2195 view, if used with the --diff option. The keyword show can be
2196 omitted if the ID is numeric.
2197 "decline" will change the request state to "declined"
2199 "reopen" will set the request back to new or review.
2201 "setincident" will direct "maintenance" requests into specific
2203 incidents
2204 "supersede" will supersede one request with another existing
2206 one.
2207 "revoke" will set the request state to "revoked"
2209 "accept" will change the request state to "accepted" and will
2211 trigger the actual submit process. That would normally be a
2212 server-side copy of the source package to the target package.
2213 "approve" marks a requests in "review" state as approved. This
2215 request will get accepted automatically when the last review got
2216 accepted.
2217 "checkout" will checkout the request's source package ("submit"
2219 requests only).
2220 "prioritize" change the priority of a request to either "criti‐
2222 cal", "important", "moderate" or "low"
2223 The 'review' command has the following sub commands:
2226 "list" lists open requests that need to be reviewed by the spec‐
2228 ified user or group
2229 "add" adds a person or group as reviewer to a request
2231 "accept" mark the review positive
2233 "decline" mark the review negative. A negative review will de‐
2235 cline the request.
2236 usage:
2238 osc request list [-M] [-U USER] [-s state] [-D DAYS] [-t
2239 type] [-B] [PRJ [PKG]]
2240 osc request log ID
2241 osc request [show] [-d] [-b] ID
2242 osc request accept [-m TEXT] ID
2244 osc request approve [-m TEXT] ID
2245 osc request cancelapproval [-m TEXT] ID
2246 osc request decline [-m TEXT] ID
2247 osc request revoke [-m TEXT] ID
2248 osc request reopen [-m TEXT] ID
2249 osc request setincident [-m TEXT] ID INCIDENT
2250 osc request supersede [-m TEXT] ID SUPERSEDING_ID
2251 osc request approvenew [-m TEXT] PROJECT
2252 osc request prioritize [-m TEXT] ID PRIORITY
2253 osc request checkout/co ID
2255 osc request clone [-m TEXT] ID
2256 osc review show [-d] [-b] ID
2258 osc review list [-U USER] [-G GROUP] [-P PROJECT [-p PACK‐
2259 AGE]] [-s state]
2260 osc review add [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT
2261 [-p PACKAGE]] ID
2262 osc review accept [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT
2263 [-p PACKAGE]] ID
2264 osc review decline [-m TEXT] [-U USER] [-G GROUP] [-P
2265 PROJECT [-p PACKAGE]] ID
2266 osc review reopen [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT
2267 [-p PACKAGE]] ID
2268 osc review supersede [-m TEXT] [-U USER] [-G GROUP] [-P
2269 PROJECT [-p PACKAGE]] ID SUPERSEDING_ID
2270 Options:
2272 -h, --help show this help message and exit
2273 --source-buildstatus
2274 print the buildstatus of the source package
2275 (only
2276 works with "show" and the interactive review)
2277 --target-package-filter=TARGET_PACKAGE_FILTER
2278 only list requests for the packages matching the
2279 package filter. A (python) regular expression is
2280 expected.
2281 --involved-projects
2282 show all requests for project/packages where
2283 USER is
2284 involved
2285 --incoming Show only requests where the project is target
2286 --exclude-target-project=EXCLUDE_TARGET_PROJECT
2287 exclude target project from request list
2288 --non-interactive
2289 non-interactive review of request
2290 --or-revoke
2291 For automation scripts: accepts (if using with
2292 accept
2293 argument) a request when it is in new or review
2294 state.
2295 Or revoke it when it got declined. Otherwise
2296 just do
2297 nothing.
2298 -i, --interactive
2299 interactive review of request
2300 -e, --edit edit a submit action
2301 -B, --bugowner
2302 also show requests about packages where I am bu‐
2303 gowner
2304 -M, --mine only show requests created by yourself
2305 -b, --brief
2306 print output in list view as list subcommand
2307 -p PACKAGE, --package=PACKAGE
2308 requests or reviews limited for the specified
2309 PACKAGE,
2310 requires also a PROJECT
2311 -P PROJECT, --project=PROJECT
2312 requests or reviews limited for the specified
2313 PROJECT
2314 -G GROUP, --group=GROUP
2315 requests or reviews limited for the specified
2316 GROUP
2317 -U USER, --user=USER
2318 requests or reviews limited for the specified
2319 USER
2320 -D DAYS, --days=DAYS
2321 only list requests in state "new" or changed in
2322 the
2323 last DAYS. [default=0]
2324 -s STATE, --state=STATE
2325 only list requests in one of the comma separated
2326 given
2327 states (new/review/accepted/revoked/declined) or
2328 "all"
2329 [default="declined,new,review", or "all", if no
2330 args
2331 given]
2332 -f, --force
2333 enforce state change, can be used to ignore open
2334 reviews
2335 -a, --all all states. Same as'-s all'
2336 -t TYPE, --type=TYPE
2337 limit to requests which contain a given action
2338 type (s
2339 ubmit/delete/change_devel/add_role/set_bu‐
2340 gowner/mainte
2341 nance_incident/maintenance_release)
2342 -m TEXT, --message=TEXT
2343 specify message TEXT
2344 --no-devel Do not attempt to forward to devel project
2345 -u, --unified
2346 output the diff in the unified diff format
2347 -S SUPERSEDED_REQUEST, --superseded-request=SUPERSEDED_RE‐
2348 QUEST
2349 Create the diff relative to a given former re‐
2350 quest
2351 -d, --diff generate a diff
2352 requestmaintainership (reqbs, reqbugownership, reqmaintainership, re‐
2356 qms, requestbugownership)
2357 requests to add user as maintainer or bugowner
2358 usage:
2360 osc requestmaintainership # for
2361 current user in checked out package
2362 osc requestmaintainership USER # for
2363 specified user in checked out package
2364 osc requestmaintainership PROJECT # for
2365 current user if cwd is not a checked out package
2366 osc requestmaintainership PROJECT group:NAME # re‐
2367 quest for specified group
2368 osc requestmaintainership PROJECT PACKAGE # for
2369 current user
2370 osc requestmaintainership PROJECT PACKAGE USER # re‐
2371 quest for specified user
2372 osc requestmaintainership PROJECT PACKAGE group:NAME # re‐
2373 quest for specified group
2374 osc requestbugownership ... # ac‐
2376 cepts same parameters but uses bugowner role
2377 Options:
2379 -h, --help show this help message and exit
2380 -r role, --role=role
2381 specify user role (default: maintainer)
2382 -m TEXT, --message=TEXT
2383 specify message TEXT
2384 resolved
2388 Remove 'conflicted' state on working copy files
2389 If an upstream change can't be merged automatically, a file is
2391 put into in 'conflicted' ('C') state. Within the file, conflicts
2392 are marked with special <<<<<<< as well as ======== and >>>>>>>
2393 lines.
2394 After manually resolving all conflicting parts, use this command
2396 to remove the 'conflicted' state.
2397 Note: this subcommand does not semantically resolve conflicts
2399 or remove conflict markers; it merely removes the conflict-re‐
2400 lated artifact files and allows PATH to be committed again.
2401 usage:
2403 osc resolved FILE [FILE...]
2404 restartbuild (abortbuild)
2407 Restart the build of a certain project or package
2408 usage:
2410 osc restartbuild [PROJECT [PACKAGE [REPOSITORY [ARCH]]]] Op‐
2411 tions:
2412 -h, --help show this help message and exit
2413 --all Restart all running builds of entire project
2414 -r REPO, --repo=REPO
2415 Restart builds for a specific repository
2416 -M MULTIBUILD_PACKAGE, --multibuild-package=MULTIBUILD_PACK‐
2417 AGE
2418 Restart builds for specified multibuild package
2419 -a ARCH, --arch=ARCH
2420 Restart builds for a specific architecture
2421 results (r)
2425 Shows the build results of a package or project
2426 Usage:
2428 osc results # (inside working copy of PRJ or
2429 PKG)
2430 osc results PROJECT [PACKAGE]
2431 Options:
2433 -h, --help show this help message and exit
2434 --show-excluded
2435 show repos that are excluded for this package
2436 --format=FORMAT
2437 format string for csv output
2438 --csv generate output in CSV format
2439 --xml generate output in XML (former results_meta)
2440 -f, --failed
2441 show only failed results
2442 -s STATUS_FILTER, --status-filter=STATUS_FILTER
2443 only show packages with the given build status
2444 -w, --watch
2445 watch the results until all finished building
2446 -V, --vertical
2447 list packages vertically instead horizontally
2448 for
2449 entire project
2450 -M MULTIBUILD_PACKAGE, --multibuild-package=MULTIBUILD_PACK‐
2451 AGE
2452 Only show results for the specified multibuild
2453 package
2454 --no-multibuild
2455 Disable results for all direct affect packages
2456 inside
2457 of the project
2458 -v, --verbose
2459 more verbose output
2460 -b, --brief
2461 show the result in "pkgname repo arch result".
2462 Default
2463 for -f
2464 -a ARCH, --arch=ARCH
2465 Show results only for specified architecture(s)
2466 -r REPO, --repo=REPO
2467 Show results only for specified repo(s)
2468 -l, --last-build
2469 show last build results (succeeded/failed/un‐
2470 known)
2471 revert Restore changed files or the entire working copy.
2475 Examples:
2477 osc revert <modified file(s)>
2478 osc revert . Note: this only works for package working
2479 copies
2480 Usage:
2482 osc revert [FILES...]
2483 rpmlintlog (lint, rpmlint)
2487 Shows the rpmlint logfile
2488 Shows the rpmlint logfile to analyse if there are any problems
2490 with the spec file and the built binaries.
2491 usage:
2493 osc rpmlintlog project package repository arch
2494 rremove
2497 Remove source files from selected package
2498 Usage:
2500 osc rremove PROJECT PACKAGE [FILES...]
2501 Options:
2503 -h, --help show this help message and exit
2504 -f, --force
2505 Don't ask and delete files
2506 search (bse, se)
2510 Search for a project and/or package.
2511 If no option is specified osc will search for projects and pack‐
2513 ages which contains the 'search term' in their name, title or
2514 description.
2515 usage:
2517 osc search 'search term' <options>
2518 osc bse ... ('osc search --binary')
2519 osc se 'perl(Foo::Bar)' ('osc search --package
2520 perl-Foo-Bar') Options:
2521 -h, --help show this help message and exit
2522 --binaryversion=VERSION
2523 search for binary with specified version (im‐
2524 plies
2525 --binary)
2526 -B PROJECT, --baseproject=PROJECT
2527 search packages built for PROJECT (implies --bi‐
2528 nary)
2529 --binary search binary packages
2530 --csv generate output in CSV (separated by |)
2531 -M, --mine shorthand for --bugowner --package
2532 --maintained
2533 OBSOLETE: please use maintained command instead.
2534 -m, --maintainer
2535 as -i, but only maintainer
2536 -b, --bugowner
2537 as -i, but only bugowner
2538 -i, --involved
2539 show projects/packages where given person (or
2540 myself)
2541 is involved as bugowner or maintainer
2542 [[{group|person}/]<name>] default: person
2543 -V, --version
2544 show package version, revision, and srcmd5. CAU‐
2545 TION:
2546 This is slow and unreliable
2547 -v, --verbose
2548 show more information
2549 -a ATTRIBUTE, --limit-to-attribute=ATTRIBUTE
2550 match only when given attribute exists in meta
2551 data
2552 --description
2553 search for matches in the 'description' element
2554 --title search for matches in the 'title' element
2555 --project search for a project
2556 --package search for a package
2557 -s, --substring
2558 Show also results where the search term is a sub
2559 string, slower search
2560 -e, --exact
2561 show only exact matches, this is default now
2562 --repos-baseurl
2563 show base URLs of download repositories
2564 sendsysrq
2568 trigger a sysrq in a running build
2569 This is only going to work when the build is running in a sup‐
2571 ported VM. Also only a subset of sysrq are supported. Typical
2572 use case for debugging are 9, t and w in this sequence.
2573 usage:
2575 osc sendsysrq REPOSITORY ARCH SYSRQ
2576 osc sendsysrq PROJECT PACKAGE REPOSITORY ARCH SYSRQ Options:
2577 -h, --help show this help message and exit
2578 -M MULTIBUILD_PACKAGE, --multibuild-package=MULTIBUILD_PACK‐
2579 AGE
2580 specify a specific multibuild flavor
2581 service
2585 Handle source services
2586 Source services can be used to modify sources like downloading
2588 files, verify files, generating files or modify existing files.
2589 usage:
2591 osc service COMMAND (inside working copy)
2592 osc service run [SOURCE_SERVICE]
2593 osc service runall
2594 osc service manualrun [SOURCE_SERVICE]
2595 osc service localrun [SOURCE_SERVICE]
2596 osc service disabledrun [SOURCE_SERVICE]
2597 osc service remoterun [PROJECT PACKAGE]
2598 osc service merge [PROJECT PACKAGE]
2599 osc service wait [PROJECT PACKAGE]
2600 COMMAND can be:
2602 run r run defined services with modes "trylocal",
2603 "localonly", or no mode set locally,
2604 may take an optional parameter to run only a
2605 specified source service. In case
2606 parameters exist for this one in _service
2607 file they are used.
2608 runall ra run all services independent of the used mode
2609 manualrun mr run all services with mode "manual", may take
2610 an optional parameter to run only a
2611 specified source service
2612 remoterun rr trigger a re-run on the server side
2613 merge commits all server side generated files and
2614 drops the _service definition
2615 wait waits until the service finishes and returns
2616 with an error if it failed
2617 Not for common usage anymore:
2619 localrun lr the same as "run" but services with mode
2620 "serveronly" are also executed
2621 disabledrun dr run all services with mode "disabled"
2622 setdevelproject (sdp)
2626 Set the devel project / package of a package
2627 Examples:
2629 osc setdevelproject [PRJ PKG] DEVPRJ [DEVPKG] Options:
2630 -h, --help show this help message and exit
2631 -u, --unset
2632 remove devel project
2633 setlinkrev
2637 Updates a revision number in a source link.
2638 This command adds or updates a specified revision number in a
2640 source link. The current revision of the source is used, if no
2641 revision number is specified.
2642 usage:
2644 osc setlinkrev
2645 osc setlinkrev PROJECT [PACKAGE] Options:
2646 -h, --help show this help message and exit
2647 -u, --unset
2648 remove revision in link, it will point always to
2649 latest revision
2650 -R, --use-plain-revision
2651 Do not expand revision the specified or latest
2652 rev
2653 -r rev, --revision=rev
2654 use the specified revision.
2655 showlinked
2659 Show all packages linking to a given one
2660 Examples:
2662 osc showlinked [PROJECT PACKAGE]
2663 signkey
2666 Manage Project Signing Key
2667 osc signkey [--create|--delete|--extend] <PROJECT> osc signkey
2669 [--notraverse] <PROJECT>
2670 This command is for managing gpg keys. It shows the public key
2672 by default. There is no way to download or upload the private
2673 part of a key by design.
2674 However you can create a new own key. You may want to consider
2676 to sign the public key with your own existing key.
2677 If a project has no key, the key from upper level project will
2679 be used (e.g. when dropping "KDE:KDE4:Community" key, the one
2680 from "KDE:KDE4" will be used).
2681 WARNING: THE OLD KEY CANNOT BE RESTORED AFTER USING DELETE OR
2683 CREATE
2684 Usage:
2686 osc signkey [ARGS...]
2687 Options:
2689 -h, --help show this help message and exit
2690 --sslcert fetch SSL certificate instead of GPG key
2691 --notraverse
2692 don't traverse projects upwards to find key
2693 --delete delete the gpg signing key in this project
2694 --extend extend expiration date of the gpg public key for
2695 this
2696 project
2697 --create create new gpg signing key for this project
2698 status (st)
2702 Show status of files in working copy
2703 Show the status of files in a local working copy, indicating
2705 whether files have been changed locally, deleted, added, ...
2706 The first column in the output specifies the status and is one
2708 of the following characters:
2709 ' ' no modifications
2710 'A' Added
2711 'C' Conflicted
2712 'D' Deleted
2713 'M' Modified
2714 'R' Replaced (file was deleted and added again afterwards)
2715 '?' item is not under version control
2716 '!' item is missing (removed by non-osc command) or incomplete
2717 'S' item is skipped (item exceeds a file size limit or is
2718 _service:* file)
2719 'F' Frozen (use "osc pull" to merge conflicts) (package-only
2720 state)
2721 examples:
2723 osc st
2724 osc st <directory>
2725 osc st file1 file2 ...
2726 usage:
2728 osc status [OPTS] [PATH...] Options:
2729 -h, --help show this help message and exit
2730 -e, --show-excluded
2731 also show files which are excluded by the
2732 "exclude_glob" config option
2733 -v, --verbose
2734 print extra information
2735 -q, --quiet
2736 print as little as possible
2737 submitrequest (sr, submitpac, submitreq)
2741 Create request to submit source into another Project
2742 [See http://en.opensuse.org/openSUSE:Build_Service_Collaboration
2744 for information on this topic.]
2745 See the "request" command for showing and modifying existing re‐
2747 quests.
2748 usage:
2750 osc submitreq [OPTIONS]
2751 osc submitreq [OPTIONS] DESTPRJ [DESTPKG]
2752 osc submitreq [OPTIONS] SOURCEPRJ SOURCEPKG DESTPRJ
2753 [DESTPKG]
2754 osc submitpac ... is a shorthand for osc submitreq --cleanup
2756 ...
2757 Options:
2759 -h, --help show this help message and exit
2760 --yes proceed without asking.
2761 -d, --diff show diff only instead of creating the actual
2762 request
2763 --update-link
2764 This transfers the source including the _link
2765 file.
2766 --no-update
2767 never touch source package on accept (will break
2768 source links)
2769 --no-cleanup
2770 never remove source package on accept, but up‐
2771 date its
2772 content
2773 --cleanup remove package if submission gets accepted (de‐
2774 fault
2775 for home:<id>:branch projects)
2776 --seperate-requests
2777 Deprecated (wrong spelling - see --separate-re‐
2778 quests)
2779 --separate-requests
2780 Create multiple requests instead of a single one
2781 (when
2782 command is used for entire project)
2783 --nodevelproject
2784 do not follow a defined devel project (primary
2785 project
2786 where a package is developed)
2787 -s REQUEST_ID, --supersede=REQUEST_ID
2788 Superseding another request by this one
2789 -r REV, --revision=REV
2790 specify a certain source revision ID (the md5
2791 sum) for
2792 the source package
2793 -F FILE, --file=FILE
2794 read log message from FILE, '-' denotes standard
2795 input.
2796 -m TEXT, --message=TEXT
2797 specify message TEXT
2798 token Show and manage authentication token
2802 Authentication token can be used to run specific commands with‐
2804 out sending credentials.
2805 Usage:
2807 osc token
2808 osc token --create [--operation <OPERATION>] [<PROJECT>
2809 <PACKAGE>]
2810 osc token --delete <TOKENID>
2811 osc token --trigger <TOKENSTRING> [--operation <OPERATION>]
2812 [<PROJECT> <PACKAGE>] Options:
2813 -h, --help show this help message and exit
2814 --scm-token=SCM_TOKEN
2815 The scm's access token (only in combination with
2816 a
2817 --operation=workflow option)
2818 -t TOKENSTRING, --trigger=TOKENSTRING
2819 Trigger the action of a token
2820 -o OPERATION, --operation=OPERATION
2821 Default is "runservice", but "branch", "re‐
2822 lease",
2823 "rebuild", or "workflow" can also be used
2824 -d TOKENID, --delete=TOKENID
2825 Delete a token
2826 -c, --create
2827 Create a new token
2828 triggerreason (tr)
2832 Show reason why a package got triggered to build
2833 The server decides when a package needs to get rebuild, this
2835 command shows the detailed reason for a package. A brief reason
2836 is also stored in the jobhistory, which can be accessed via "osc
2837 jobhistory".
2838 Trigger reasons might be:
2840 - new build (never build yet or rebuild manually forced)
2841 - source change (e.g. on updating sources)
2842 - meta change (packages which are used for building have
2843 changed)
2844 - rebuild count sync (In case that it is configured to sync
2845 release numbers)
2846 usage in package or project directory:
2848 osc triggerreason REPOSITORY ARCH
2849 osc triggerreason PROJECT PACKAGE REPOSITORY ARCH
2850 Options:
2852 -h, --help show this help message and exit
2853 -M MPAC, --multibuild-package=MPAC
2854 get triggerreason of the specified multibuild
2855 package
2856 undelete
2860 Restores a deleted project or package on the server.
2861 The server restores a package including the sources and meta
2863 configuration. Binaries remain to be lost and will be rebuild.
2864 usage:
2866 osc undelete PROJECT
2867 osc undelete PROJECT PACKAGE [PACKAGE ...]
2868 Options:
2870 -h, --help show this help message and exit
2871 -m TEXT, --message=TEXT
2872 specify log message TEXT
2873 unlock Unlocks a project or package
2877 Unlocks a locked project or package. A comment is required.
2879 usage:
2881 osc unlock PROJECT [PACKAGE]
2882 Options:
2884 -h, --help show this help message and exit
2885 -m TEXT, --message=TEXT
2886 specify log message TEXT
2887 update (up)
2891 Update a working copy
2892 examples:
2894 1. osc up
2896 If the current working directory is a package, update
2897 it.
2898 If the directory is a project directory, update all con‐
2899 tained
2900 packages, AND check out newly added packages.
2901 To update only checked out packages, without checking
2903 out new
2904 ones, you might want to use "osc up *" from within the
2905 project
2906 dir.
2907 2. osc up PAC
2909 Update the packages specified by the path argument(s)
2910 When --expand-link is used with source link packages, the ex‐
2912 panded sources will be checked out. Without this option, the
2913 _link file and patches will be checked out. The option --unex‐
2914 pand-link can be used to switch back to the "raw" source with a
2915 _link file plus patch(es).
2916 Usage:
2918 osc update [ARGS...]
2919 Options:
2921 -h, --help show this help message and exit
2922 -l limit_size, --limit-size=limit_size
2923 Skip all files with a given size
2924 -S, --server-side-source-service-files
2925 Use server side generated sources instead of lo‐
2926 cal
2927 generation.
2928 -s, --source-service-files
2929 Run local source services after update.
2930 -e, --expand-link
2931 if a package is a link, update to the expanded
2932 sources
2933 -u, --unexpand-link
2934 if a package is an expanded link, update to the
2935 raw
2936 _link file
2937 --linkrev=REV
2938 revision of the link target that is used during
2939 link
2940 expansion
2941 -r REV, --revision=REV
2942 update to specified revision (this option will
2943 be
2944 ignored if you are going to update the complete
2945 project or more than one package)
2946 updatepacmetafromspec (metafromspec, updatepkgmetafromspec)
2950 Update package meta information from a specfile
2951 ARG, if specified, is a package working copy.
2953 Usage:
2955 osc updatepacmetafromspec [ARGS...]
2956 Options:
2958 -h, --help show this help message and exit
2959 --specfile=FILE
2960 Path to specfile. (if you pass more than working
2961 copy
2962 this option is ignored)
2963 vc Edit the changes file
2967 osc vc [-m MESSAGE|-e] [filename[.changes]|path [file_with_com‐
2969 ment]] If no <filename> is given, exactly one *.changes or
2970 *.spec file has to be in the cwd or in path.
2971 The email address used in .changes file is read from BuildSer‐
2973 vice instance, or should be defined in oscrc [https://api.open‐
2974 suse.org/] user = login pass = password email = user@de‐
2975 fined.email
2976 or can be specified via mailaddr environment variable.
2978 Usage:
2980 osc vc [ARGS...]
2981 Options:
2983 -h, --help show this help message and exit
2984 -e, --just-edit
2985 just open changes (cannot be used with -m)
2986 -F FILE, --file=FILE
2987 read changes message from FILE (do not open an
2988 editor)
2989 -m MESSAGE, --message=MESSAGE
2990 add MESSAGE to changes (do not open an editor)
2991 whatdependson
2995 Show the packages that require the specified package during the
2996 build.
2997 The command whatdependson can be used to find out what will be
2999 triggered when a certain package changes.
3000 This is no guarantee, since the new build might have changed de‐
3002 pendencies.
3003 The arguments REPOSITORY and ARCH can be taken from the first
3005 two columns of the 'osc repos' output.
3006 usage in package or project directory:
3008 osc whatdependson REPOSITORY ARCH
3009 usage:
3011 osc whatdependson PROJECT [PACKAGE] REPOSITORY ARCH
3012 whois (user, who)
3016 Show fullname and email of a buildservice user
3017 Usage:
3019 osc whois [USERNAMES...]
3020 wipebinaries (unpublish)
3024 Delete all binary packages of a certain project/package
3025 With the optional argument <package> you can specify a certain
3027 package otherwise all binary packages in the project will be
3028 deleted.
3029 usage:
3031 osc wipebinaries OPTS # works in
3032 checked out project dir
3033 osc wipebinaries OPTS PROJECT [PACKAGE]
3034 osc unpublish OPTS # works in checked
3035 out project dir
3036 osc unpublish OPTS PROJECT [PACKAGE] Options:
3037 -h, --help show this help message and exit
3038 --all Delete all binaries regardless of the package
3039 status
3040 (previously default)
3041 --unresolvable
3042 Delete all binaries of packages which have de‐
3043 pendency
3044 errors
3045 --broken Delete all binaries of packages for which the
3046 package
3047 source is bad
3048 --build-failed
3049 Delete all binaries of packages for which the
3050 build
3051 failed
3052 --build-disabled
3053 Delete all binaries of packages for which the
3054 build is
3055 disabled
3056 -r REPO, --repo=REPO
3057 Delete all binary packages for a specific repos‐
3058 itory
3059 -M MULTIBUILD_PACKAGE, --multibuild-package=MULTIBUILD_PACK‐
3060 AGE
3061 Delete all binary packages for specified multi‐
3062 build
3063 package
3064 -a ARCH, --arch=ARCH
3065 Delete all binary packages for a specific archi‐
3066 tecture
3067 workerinfo
3071 gets the information to a worker from the server
3072 Examples:
3074 osc workerinfo x86_64:goat:1
3075 Usage:
3077 osc workerinfo <hostarch>:<workerid>
3078 GLOBAL OPTIONS
3083 Options:
3084 --version show program's version number and exit
3085 -h, --help show this help message and exit
3086 --debugger jump into the debugger before executing any‐
3087 thing
3088 --post-mortem jump into the debugger in case of errors
3089 -t, --traceback print call trace in case of errors
3090 -H, --http-debug debug HTTP traffic (filters some headers)
3091 --http-full-debug debug HTTP traffic (filters no headers)
3092 -d, --debug print info useful for debugging
3093 -A URL/alias, --apiurl=URL/alias
3094 specify URL to access API server at or an alias
3095 -c FILE, --config=FILE
3096 specify alternate configuration file
3097 --no-keyring disable usage of desktop keyring system
3098 --no-gnome-keyring disable usage of GNOME Keyring
3099 -v, --verbose increase verbosity
3100 -q, --quiet be quiet, not verbose
3101
3105 Type 'osc help <subcommand>' for more detailed help on a specific sub‐
3106 command.
3107 For additional information, see
3109 * http://en.opensuse.org/openSUSE:Build_Service_Tutorial
3110 * http://en.opensuse.org/openSUSE:OSC
3111 You can modify osc commands, or roll your own, via the plugin API:
3113 * http://en.opensuse.org/openSUSE:OSC_plugins
3114
3116 osc was written by several authors. This man page is automatically gen‐
3117 erated.
3118osc 0.180.0 Jul 2022 OSC(1)