make.conf.5: better examples for ACCEPT_LICENSE
[portage.git] / man / emirrordist.1
1 .TH "EMIRRORDIST" "1" "Jan 2013" "Portage VERSION" "Portage"
2 .SH "NAME"
3 emirrordist \- a fetch tool for mirroring of package distfiles
4 .SH SYNOPSIS
5 .B emirrordist
6 [\fIoptions\fR] \fI<action>\fR
7 .SH ACTIONS
8 .TP
9 \fB\-h\fR, \fB\-\-help\fR
10 Show a help message and exit.
11 .TP
12 \fB\-\-version\fR
13 Display portage version and exit.
14 .TP
15 \fB\-\-mirror\fR
16 Mirror distfiles for the selected repository.
17 .SH OPTIONS
18 .TP
19 \fB\-\-dry\-run\fR
20 Perform a trial run with no changes made (typically combined
21 with \fI\-v\fR or \fI\-vv\fR).
22 .TP
23 \fB\-v\fR, \fB\-\-verbose\fR
24 Display extra information on stderr (multiple occurences
25 increase verbosity).
26 .TP
27 \fB\-\-ignore\-default\-opts\fR
28 Do not use the \fIEMIRRORDIST_DEFAULT_OPTS\fR environment
29 variable.
30 .TP
31 \fB\-\-distfiles\fR=\fIDIR\fR
32 Distfiles directory to use (required).
33 .TP
34 \fB\-j\fR JOBS, \fB\-\-jobs\fR=\fIJOBS\fR
35 Number of concurrent jobs to run.
36 .TP
37 \fB\-l\fR LOAD, \fB\-\-load\-average\fR=\fILOAD\fR
38 Load average limit for spawning of new concurrent jobs.
39 .TP
40 \fB\-\-tries\fR=\fITRIES\fR
41 Maximum number of tries per file, 0 means unlimited
42 (default is 10).
43 .TP
44 \fB\-\-repo\fR=\fIREPO\fR
45 Name of repo to operate on (default repo is located at
46 $PORTDIR).
47 .TP
48 \fB\-\-config\-root\fR=\fIDIR\fR
49 Location of portage config files.
50 .TP
51 \fB\-\-portdir\fR=\fIDIR\fR
52 Override the portage tree location.
53 .TP
54 \fB\-\-portdir\-overlay\fR=\fIPORTDIR_OVERLAY\fR
55 Override the PORTDIR_OVERLAY variable (requires that
56 \fI\-\-repo\fR is also specified).
57 .TP
58 \fB\-\-strict\-manifests=\fR<y|n>
59 Manually override "strict" FEATURES setting.
60 .TP
61 \fB\-\-failure\-log\fR=\fIFILE\fR
62 Log file for fetch failures, with tab\-delimited output, for
63 reporting purposes. Opened in append mode.
64 .TP
65 \fB\-\-success\-log\fR=\fIFILE\fR
66 Log file for fetch successes, with tab\-delimited output, for
67 reporting purposes. Opened in append mode.
68 .TP
69 \fB\-\-scheduled\-deletion\-log\fR=\fIFILE\fR
70 Log file for scheduled deletions, with tab\-delimited output, for
71 reporting purposes. Overwritten with each run.
72 .TP
73 \fB\-\-delete\fR
74 Enable deletion of unused distfiles.
75 .TP
76 \fB\-\-deletion\-db\fR=\fIFILE\fR
77 Database file used to track lifetime of files scheduled for
78 delayed deletion.
79 .TP
80 \fB\-\-deletion\-delay\fR=\fISECONDS\fR
81 Delay time for deletion of unused distfiles, measured in seconds.
82 .TP
83 \fB\-\-temp\-dir\fR=\fIDIR\fR
84 Temporary directory for downloads.
85 .TP
86 \fB\-\-mirror\-overrides\fR=\fIFILE\fR
87 File holding a list of mirror overrides.
88 .TP
89 \fB\-\-mirror\-skip\fR=\fIMIRROR_SKIP\fR
90 Comma delimited list of mirror targets to skip when
91 fetching.
92 .TP
93 \fB\-\-restrict\-mirror\-exemptions\fR=\fIRESTRICT_MIRROR_EXEMPTIONS\fR
94 Comma delimited list of mirror targets for which to ignore
95 RESTRICT="mirror" (see \fBebuild\fR(5)).
96 .TP
97 \fB\-\-verify\-existing\-digest\fR
98 Use digest as a verification of whether existing
99 distfiles are valid.
100 .TP
101 \fB\-\-distfiles\-local\fR=\fIDIR\fR
102 The distfiles\-local directory to use.
103 .TP
104 \fB\-\-distfiles\-db\fR=\fIFILE\fR
105 Database file used to track which ebuilds a distfile belongs to.
106 .TP
107 \fB\-\-recycle\-dir\fR=\fIDIR\fR
108 Directory for extended retention of files that are removed from
109 distdir with the \-\-delete option. These files may be be recycled if
110 they are needed again, instead of downloading them again.
111 .TP
112 \fB\-\-recycle\-db\fR=\fIFILE\fR
113 Database file used to track lifetime of files in recycle dir.
114 .TP
115 \fB\-\-recycle\-deletion\-delay\fR=\fISECONDS\fR
116 Delay time for deletion of unused files from recycle dir,
117 measured in seconds (defaults to the equivalent of 60 days).
118 .TP
119 \fB\-\-fetch\-log\-dir\fR=\fIDIR\fR
120 Directory for individual fetch logs.
121 .TP
122 \fB\-\-whitelist\-from\fR=\fIFILE\fR
123 Specifies a file containing a list of files to whitelist, one per line,
124 # prefixed lines ignored. Use this option multiple times in order to
125 specify multiple whitelists.
126 .SH "REPORTING BUGS"
127 Please report bugs via http://bugs.gentoo.org/
128 .SH "THANKS"
129 Special thanks to Brian Harring, author of the mirror\-dist program from
130 which emirrordist is derived.
131 .SH "AUTHORS"
132 .nf
133 Zac Medico <zmedico@gentoo.org>
134 .fi
135 .SH "FILES"
136 .TP
137 .B /etc/portage/make.conf
138 Contains variables.
139 .SH "SEE ALSO"
140 .BR ebuild (5),
141 .BR egencache (1),
142 .BR make.conf (5),
143 .BR portage (5)