.\" Man page generated from reStructuredText.
.
.TH "PLUGINS" "1" "Jun 15, 2019" "2.0" "Quantum Package"
.SH NAME
plugins \-  | Quantum Package >
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
\fIQuantum Package\fP has very few executables out of the box. Most of the time,
external plugins need to be downloaded and installed in the
\fB$QP_ROOT/plugins\fP directory.
.sp
Plugins are usually hosted in external repositories. To download a
plugin, the remote repository needs to be downloaded, and the plugins of
the repository can be selected for installation.
.sp
To download an external repository of plugins, run the following
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
qp_plugins download http://somewhere/over/the/rainbow/ext_repo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This downloads a copy of the repository of external plugins \fBext_repo\fP
in \fB$QP_ROOT/plugins\fP\&.
.sp
The list of available uninstalled plugins can be seen using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
qp_plugins list \-u
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Now, the specific plugin \fBext_module\fP contained in the repository
\fBext_repo\fP can be installed using:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
qp_plugins install ext_module
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The module is now accessible via a symbolic link in \fB$QP_ROOT/src\fP,
and can be compiled as any module, running \fI\%Ninja\fP\&.
.sp
To remove the module, run
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
qp_plugins uninstall ext_module
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
For a more detailed explanation and an example, see qp_plugins\&.
.UNINDENT
.UNINDENT
.SH AUTHOR
A. Scemama, E. Giner
.SH COPYRIGHT
2019, A. Scemama, E. Giner
.\" Generated by docutils manpage writer.
.