repository.eselect.5.in

.\" -*- coding: utf-8 -*-
.\" Copyright 2019 Till Schäfer
.\" Copyright 2021 Michał Górny
.\" Distributed under the terms of the 2-clause BSD license
.\"
.TH repository.eselect 5 "07 Apr 2021" "Gentoo Linux" "eselect"
.SH NAME
\fBrepository.eselect\fP - Manage repos.conf via eselect
.SH SYNOPSIS
.nf
.fam C
\fBeselect\fP \fBrepository\fP [\fBhelp\fP|\fBusage\fP|\fBversion\fP]
\fBeselect\fP \fBrepository\fP \fBadd\fP \fIname\fP \fIsync-type\fP \fIsync-uri\fP
\fBeselect\fP \fBrepository\fP \fBdisable\fP [\fB-f\fP] (\fIname\fP|\fIindex\fP)
\fBeselect\fP \fBrepository\fP \fBenable\fP (\fIname\fP|\fIindex\fP)
\fBeselect\fP \fBrepository\fP \fBlist\fP [\fB-i\fP]
\fBeselect\fP \fBrepository\fP \fBremove\fP [\fB-f\fP] (\fIname\fP|\fIindex\fP)

.SH DESCRIPTION
\fBrepository.eselect\fP is an eselect module for manipulating /etc/portage/repos.conf entries to third party repositories (also known as overlays). This supersedes the need for app-admin/layman to list, configure, and handle synchronizations of alternate repositories except for those which the package manager does not (eg. mercurial, bazaar and g-sorcery in portage).
.SH ACTION: ADD
Add a custom repository
.PP
\fBeselect\fP \fBrepository\fP \fBadd\fP \fIname\fP \fIsync-type\fP \fIsync-uri\fP
.PP
Parameters:
.TP
.B
\fIname\fP
Name of the repository to add
.TP
.B
\fIsync-type\fP
Syncer to use (e.g. git, rsync, svn\.\.\.)
.TP
.B
\fIsync-uri\fP
Sync URI
.SH ACTION: CREATE
Create a local repository, initialize it with some boilerplate and add
it to repos.conf
.PP
\fBeselect\fP \fBrepository\fP \fBcreate\fP \fIname\fP \fI[path]\fP
.PP
Parameters:
.TP
.B
\fIname\fP
Name of the repository to create
.TP
.B
\fIpath\fP
Directory to create the repository in. If not specified, defaults
to a subdirectory of storage dir matching \fIname\fP
.TP
.B
\fIsync-uri\fP
Sync URI
.SH ACTION: DISABLE
Disable specified repositories without removing their contents
.PP
\fBeselect\fP \fBrepository\fP \fBdisable\fP [\fB-f\fP] (\fIname\fP|\fIindex\fP)
.PP
Parameters:
.TP
.B
\fB-f\fP
Force potentially dangerous removals. Required for unregistered repositories and those without sync attributes.
.TP
.B
\fIname\fP
Names of repositories to disable
.TP
.B
\fIindex\fP
Numeric index of the repository (from 'list' command)
.SH ACTION: ENABLE
Enable the specified repositories from the list
.PP
\fBeselect\fP \fBrepository\fP \fBenable\fP (\fIname\fP|\fIindex\fP)
.PP
Parameters:
.TP
.B
\fIname\fP
Names of repositories to enable
.TP
.B
\fIindex\fP
Numeric index of the repository (from 'list' command)
.SH ACTION: LIST
List all repositories. The repositories in the listing are suffixed by a symbol, that indicates their
current state.
.PP
\fBeselect\fP \fBrepository\fP \fBlist\fP [\fB-i\fP]
.PP
Parameters:
.TP
.B
\fB-i\fP
Only list installed
.PP
State suffixes:
.TP
.B
*
Repository is enabled
.TP
.B
#
Repositorys sync information is out of date and needs to be updated (via
disable/enable) or is customized
.TP
.B
@
Repository is not listed by name in the official, published list
.SH ACTION: REMOVE
Remove installed repositories along with their contents
.PP
\fBeselect\fP \fBrepository\fP \fBremove\fP [\fB-f\fP] (\fIname\fP|\fIindex\fP)
.PP
Parameters:
.TP
.B
\fB-f\fP
Force potentially dangerous removals. Required for unregistered repositories and those without sync attributes.
.TP
.B
\fIname\fP
Names of repositories to remove
.TP
.B
\fIindex\fP
Numeric index of the repository (from 'list' command)

.SH EXAMPLES
Listing registered repositories
.PP
.nf
.fam C
        # eselect repository list
        Available repositories:
          [1]   foo
          [2]   bar
          [3]   baz
          [4]   cross #
          [5]   good *
          [6]   my_overlay @

.fam T
.fi
Add registered repositories
.PP
.nf
.fam C
        # eselect repository enable foo bar baz

.fam T
.fi
Add unregistered repositories
.PP
.nf
.fam C
        # eselect repository add test git https://github.com/test/test.git

.fam T
.fi
Disable repositories without removing contents
.PP
.nf
.fam C
        # eselect repository disable foo bar baz

.fam T
.fi
Disable repositories and remove contents
.PP
.nf
.fam C
        # eselect repository remove foo bar baz

.fam T
.fi
.SH FILES
.TP
.B
/etc/eselect/repository.conf
Configuration for repository.eselect
.SH SEE ALSO
\fBeselect\fP(1), \fBportage\fP(5)