/ docs / pkg-plugins.8
pkg-plugins.8
  1  .\"
  2  .\" FreeBSD pkg - a next generation package for the installation and maintenance
  3  .\" of non-core utilities.
  4  .\"
  5  .\" Redistribution and use in source and binary forms, with or without
  6  .\" modification, are permitted provided that the following conditions
  7  .\" are met:
  8  .\" 1. Redistributions of source code must retain the above copyright
  9  .\"    notice, this list of conditions and the following disclaimer.
 10  .\" 2. Redistributions in binary form must reproduce the above copyright
 11  .\"    notice, this list of conditions and the following disclaimer in the
 12  .\"    documentation and/or other materials provided with the distribution.
 13  .\"
 14  .\"
 15  .\"     @(#)pkg.8
 16  .\"
 17  .Dd March 2, 2026
 18  .Dt PKG-PLUGINS 8
 19  .Os
 20  .Sh NAME
 21  .Nm "pkg plugins"
 22  .Nd list available plugins
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Op Fl l
 26  .Pp
 27  .Nm
 28  .Op Cm --list-only
 29  .Sh DESCRIPTION
 30  .Nm
 31  is used to display the available
 32  .Xr pkg 8
 33  plugins.
 34  It prints a table listing each plugin's name, description and version.
 35  .Pp
 36  Plugins must be enabled by setting
 37  .Va PKG_ENABLE_PLUGINS
 38  to
 39  .Dq Li true
 40  in
 41  .Xr pkg.conf 5
 42  and listing the desired plugins in the
 43  .Va PLUGINS
 44  array.
 45  .Sh OPTIONS
 46  The following options are supported by
 47  .Nm :
 48  .Bl -tag -width list-only
 49  .It Fl l , Cm --list-only
 50  List available plugins.
 51  This is currently the default behavior.
 52  .El
 53  .Sh ENVIRONMENT
 54  The following environment variables affect the execution of
 55  .Nm .
 56  See
 57  .Xr pkg.conf 5
 58  for further description.
 59  .Bl -tag -width ".Ev PKG_ENABLE_PLUGINS"
 60  .It Ev PKG_ENABLE_PLUGINS
 61  .It Ev PLUGINS
 62  .It Ev PLUGINS_DIR
 63  .El
 64  .Sh FILES
 65  See
 66  .Xr pkg.conf 5 .
 67  .Sh SEE ALSO
 68  .Xr pkg_create 3 ,
 69  .Xr pkg_printf 3 ,
 70  .Xr pkg_repo_create 3 ,
 71  .Xr pkg_repos 3 ,
 72  .Xr pkg-keywords 5 ,
 73  .Xr pkg-lua-script 5 ,
 74  .Xr pkg-repository 5 ,
 75  .Xr pkg-script 5 ,
 76  .Xr pkg-triggers 5 ,
 77  .Xr pkg.conf 5 ,
 78  .Xr pkg 8 ,
 79  .Xr pkg-add 8 ,
 80  .Xr pkg-alias 8 ,
 81  .Xr pkg-annotate 8 ,
 82  .Xr pkg-audit 8 ,
 83  .Xr pkg-autoremove 8 ,
 84  .Xr pkg-check 8 ,
 85  .Xr pkg-clean 8 ,
 86  .Xr pkg-config 8 ,
 87  .Xr pkg-create 8 ,
 88  .Xr pkg-delete 8 ,
 89  .Xr pkg-fetch 8 ,
 90  .Xr pkg-help 8 ,
 91  .Xr pkg-info 8 ,
 92  .Xr pkg-install 8 ,
 93  .Xr pkg-key 8 ,
 94  .Xr pkg-lock 8 ,
 95  .Xr pkg-query 8 ,
 96  .Xr pkg-register 8 ,
 97  .Xr pkg-repo 8 ,
 98  .Xr pkg-repositories 8 ,
 99  .Xr pkg-rquery 8 ,
100  .Xr pkg-search 8 ,
101  .Xr pkg-set 8 ,
102  .Xr pkg-shell 8 ,
103  .Xr pkg-shlib 8 ,
104  .Xr pkg-ssh 8 ,
105  .Xr pkg-stats 8 ,
106  .Xr pkg-triggers 8 ,
107  .Xr pkg-unregister 8 ,
108  .Xr pkg-update 8 ,
109  .Xr pkg-updating 8 ,
110  .Xr pkg-upgrade 8 ,
111  .Xr pkg-version 8 ,
112  .Xr pkg-which 8