radare2/man/r2pm.1
2021-06-30 21:57:19 +02:00

80 lines
1.9 KiB
Groff

.Dd Jun 30, 2021
.Dt R2PM 1
.Sh NAME
.Nm R2PM
.Nd radare2 package manager
.Sh SYNOPSIS
.Nm r2pm
.Op init|update|cmd
.Op ...
.Sh DESCRIPTION
Allows to install, update, uninstall and discover plugins and tools that can be used with radare2.
.Bl -tag -width Fl
.It Fl a, Cm repo
Adds an external r2pm repository, no arguments to -a will list all the registered repos, use '-a - repo' to unregister/remove those repos.
.It Fl I, Cm info
Show information about repository and installed packages
.It Fl i, Cm install Ar pkgname
Install a package
.It Fl gi, Cm global-install Ar pkgname
Install a package in the system directory
.It Fl u, Cm uninstall Ar pkgname
Uninstall a package
.It Fl U, Cm Upgrade all the outdated packages
Runs the suggested lines when loading outdated plugins by r2
.It Fl gu, Cm global-install Ar pkgname
Uninstall a package from the system directory
.It Fl l, Cm list
List installed packages
.It Fl s, Cm search Ar keyword
Search in database for packages matching keyword
.It Fl r, Cm run Ar command ...args
Run command with R2PM_BINDIR in PATH
.It Fl v, Cm version
Show version information
.It Fl h, Cm help
Show usage help message
.It Fl c, Cm clean
Clean the source cache
.It Fl w, Cm when
Show when a package was installed or exit 1 if pkg does not exist
.El
.Sh EXAMPLES
.Pp
Initialize and update the package database
.Pp
$ r2pm init
$ r2pm update
.Pp
Install a package
.Pp
$ r2pm install yara3
.Pp
Install a test package (don't git pull on $R2PM_GITDIR/yara3)
.Pp
$ R2PM_GITSKIP=1 r2pm install yara3
.Pp
Uninstall a package
.Pp
$ r2pm uninstall yara3
.Pp
Search a package
.Pp
$ r2pm search yara
.Pp
List available packages
.Pp
$ r2pm -s
.Sh ENVIRONMENT
.Pp
SUDO=sudo
R2PM_PLUGDIR=~/.local/share/radare2/plugins
R2PM_BINDIR=~/.local/share/radare2/prefix/bin
R2PM_OFFLINE=0
R2PM_DBDIR=~/.local/share/radare2/r2pm/db
R2PM_GITDIR=~/.local/share/radare2/r2pm/git
R2PM_GITSKIP=
.Sh SEE ALSO
.Pp
.Xr radare2(1)