1scl(1) General Commands Manual scl(1)
2
6 scl - Setup and run software from Software Collection environment
7
9 scl <action> [<collection1> <collection2> ...] <command>
10 scl <action> <collection1> [<collection2> ...] -- <command>
12 scl {-l|--list}
14 scl register <path>
16 scl deregister <collection> [--force]
18
20 This manual page documents scl, a program which is an utility for run‐
21 ning software packaged as a Software Collection.
22 scl utility allows to execute an application which is not located in
24 the filesystem root hierarchy but is present in an alternative loca‐
25 tion. This application can still use and benefit from software
26 installed in the root filesystem. In order to let an application be
27 visible to the system one has to use scl utility as an interface.
28 <action> is a script name to execute in a bash environment before the
30 application itself takes in executed. Currently only enable scriptlet
31 is mandatory which is needed to update search paths, etc.
32 One can enable more Software Collections if needed and therefore one
34 can use multiple collections which are enabled by the left-right order
35 as present on scl command-line.
36 <command> marks specified Software Collections as enabled. Executes the
38 script, which is expected to set proper environment. Executes the <com‐
39 mand>. Control is returned back to the caller with the original envi‐
40 ronment as soon as the command finishes. If <command> is '-' (dash)
41 then it is read from the standard input.
42 Note: if you use <command> consisting of multiple arguments, you either
44 need to use quotes or the -- command separator. Everything that follows
45 the separator will be considered a command or its argument.
46 Note: some commands modify user environment in some way. Those commands
48 may potentially break SCLs, as their activation also usually depends on
49 env. modification as well. Typical examples of such commands are su
50 and sudo. Every collection modifies the environment differently, thus
51 more details may be found in the documentation of the particular col‐
52 lection.
53
55 -l, --list
56 Lists all installed Software Collections on the system. If a
57 collection name is specified then list of installed packages
58 belonging to the collection is listed.
59 register <path>
61 If <path> leads to valid SCL file structure, scl will regis‐
62 ter that as a SCL. <path> directory needs to contain enable
63 scriptlet and root directory, to be considered valid SCL.
64 <path> needs to be an absolute path to the collection loca‐
65 tion.
66 deregister <collection> [--force]
68 <collection> will no longer be considered SCL. If the <col‐
69 lection> was installed locally, then the use of --force is
70 needed.i
71
73 scl enable example 'less --version'
74 runs command 'less --version' in the environment with collection
75 'example' enabled
76 scl enable foo bar bash
78 runs bash instance with foo and bar Software Collections enabled
79 cat my_command | scl enable baz -
81 run set of commands listed in my_command file in the environment
82 with baz Software Collection enabled
83 scl -l list all installed collections
85 scl -l example
87 list all packages within example collection scl register
88 /foo/bar registers new collection with a name bar
89 scl deregister bar --force
91 forces the deregistration of collection bar
92 AUTHOR
95 scl was written by Jindrich Novy <jnovy@redhat.com> and Jan Zeleny
97 <jzeleny@redhat.com>
98 scl(1)