replace perl euse with bash euse
[gentoolkit.git] / trunk / src / euse / euse.1
1 .TH "EUSE" "1" "2004-10-17" "Gentoo Linux" "Gentoo Toolkit"
2 .SH "NAME"
3 euse \- Gentoo: command line USE flag editor
4 .SH "SYNOPSIS"
5 .B euse
6 \fI<option> [suboption] [useflaglist]\fB
7 .SH "DESCRIPTION"
8 .PP 
9 .I euse
10 is used to set(disable/enable) USE flags in /etc/make.conf without having to edit
11 the file directly. It is also used to get detail information about use flags
12 like description, status of flags(enabled/disabled), type of flag(global/local)
13 etc.
14 .SH "OPTIONS "
15 .TP 
16 \fB\-E, \-\-enable\fI
17 Enables USE flag(s) in make.conf. It accepts one or more space seperated 
18 USE flags as parameters.
19 .TP 
20 \fB\-D, \-\-disable\fI
21 Disables USE flag(s) in make.conf. Puts a '\-' sign in front of the USE flag
22 and appends it to the USE setting in make.conf. It accepts one or more 
23 space seperated USE flags as parameters.
24 .TP 
25 \fB\-P, \-\-prune\fI
26 Removes USE flag(s) in make.conf. Removes all positive and negative references to
27 the given USE flags from make.conf.
28 .TP 
29 \fB\-i, \-\-info\fI
30 Prints detail information about the USE flag(s). If no arguments are given then
31 it assumes you want information for all USE flags. If one or more
32 arguments are given (space separated) then only information for those flags is
33 printed. 
34 .sp
35 .RS
36 The output is in the following format:
37 .br 
38 \fB[\- cD ]\fI alpha \- indicates that architecture ...
39 .br 
40 \fB[\-   ]\fI moznocompose (net\-www/mozilla):.br 
41 Disable building of mozilla's web page composer 
42 .br 
43 The the indicators in the first column are:
44 .IP is_active
45 + if the flag is seen as active by portage, \- if not
46 .IP is_in_env
47 E if the flag is enabled in the environment, e if it is
48 disabled in the environment, nothing if it's not affected
49 by the environment
50 .IP is_in_make_conf
51 C if the flag is enabled in make.conf, c if it is
52 disabled in make.conf, nothing if it's not affected
53 by make.conf
54 .IP is_in_make_defaults
55 D if the flag is enabled in make.defaults, d if it is
56 disabled in make.defaults, nothing if it's not affected
57 by make.defaults
58 .IP is_in_make_globals
59 G if the flag is enabled in make.globals, g if it is
60 disabled in make.globals, nothing if it's not affected
61 by make.globals
62 .br 
63 Then follows the name of the flag, for local flags the
64 package name and then the description (on a new line for
65 local flags).
66 .TP 
67 \fB\-a, \-\-active\fI
68 Shows all currently active USE flags and where they are activated (see 
69 description for \fB\-\-info\fI).
70 .TP 
71 \fB\-h, \-\-help\fI
72 Show the help message listing all the available flags and a short description
73 .TP 
74 \fB\-v, \-\-version\fI
75 Show the version information
76 .SH "FILES"
77 /etc/make.conf
78 .br 
79 /etc/make.profile/make.defaults
80 .br 
81 /etc/make.globals
82 .br 
83 $PORTDIR/profiles/use.desc
84 .br 
85 $PORTDIR/profiles/use.local.desc
86 .br 
87
88 .SH "AUTHOR"
89 Original version by Arun Bhanu <codebear@gentoo.org>
90 .br 
91 Updated for rewritten euse by Marius Mauch <genone@gentoo.org>
92 .SH "BUGS"
93 euse doesn't handle USE flags enabled or disabled by use.defaults, use.mask
94 or package.use yet. It also doesn't completely understand the \-* flag.
95 .SH "SEE ALSO"
96 .BR ufed(8), 
97 .TP 
98 The \fI/usr/bin/euse\fR script.