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-HELP 8
 19  .Os
 20  .Sh NAME
 21  .Nm "pkg help"
 22  .Nd display usage information for pkg commands
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Ar command
 26  .Sh DESCRIPTION
 27  .Nm
 28  is used to display the manual page for a
 29  .Xr pkg 8
 30  command.
 31  When invoked with a valid command name,
 32  .Nm
 33  opens the corresponding manual page using
 34  .Xr man 1 .
 35  .Pp
 36  If the specified command is an alias defined in
 37  .Xr pkg.conf 5 ,
 38  .Nm
 39  displays the alias expansion instead.
 40  .Pp
 41  When invoked without arguments,
 42  .Nm
 43  displays a brief usage summary of all available
 44  .Xr pkg 8
 45  commands.
 46  .Sh EXAMPLES
 47  Display the manual page for the
 48  .Cm install
 49  command:
 50  .Dl $ pkg help install
 51  .Pp
 52  Display the manual page for
 53  .Xr pkg.conf 5 :
 54  .Dl $ pkg help pkg.conf
 55  .Pp
 56  Display all available commands:
 57  .Dl $ pkg help
 58  .Sh SEE ALSO
 59  .Xr pkg_create 3 ,
 60  .Xr pkg_printf 3 ,
 61  .Xr pkg_repo_create 3 ,
 62  .Xr pkg_repos 3 ,
 63  .Xr pkg-keywords 5 ,
 64  .Xr pkg-lua-script 5 ,
 65  .Xr pkg-repository 5 ,
 66  .Xr pkg-script 5 ,
 67  .Xr pkg-triggers 5 ,
 68  .Xr pkg.conf 5 ,
 69  .Xr pkg 8 ,
 70  .Xr pkg-add 8 ,
 71  .Xr pkg-alias 8 ,
 72  .Xr pkg-annotate 8 ,
 73  .Xr pkg-audit 8 ,
 74  .Xr pkg-autoremove 8 ,
 75  .Xr pkg-check 8 ,
 76  .Xr pkg-clean 8 ,
 77  .Xr pkg-config 8 ,
 78  .Xr pkg-create 8 ,
 79  .Xr pkg-delete 8 ,
 80  .Xr pkg-fetch 8 ,
 81  .Xr pkg-info 8 ,
 82  .Xr pkg-install 8 ,
 83  .Xr pkg-key 8 ,
 84  .Xr pkg-lock 8 ,
 85  .Xr pkg-plugins 8 ,
 86  .Xr pkg-query 8 ,
 87  .Xr pkg-register 8 ,
 88  .Xr pkg-repo 8 ,
 89  .Xr pkg-repositories 8 ,
 90  .Xr pkg-rquery 8 ,
 91  .Xr pkg-search 8 ,
 92  .Xr pkg-set 8 ,
 93  .Xr pkg-shell 8 ,
 94  .Xr pkg-shlib 8 ,
 95  .Xr pkg-ssh 8 ,
 96  .Xr pkg-stats 8 ,
 97  .Xr pkg-triggers 8 ,
 98  .Xr pkg-unregister 8 ,
 99  .Xr pkg-update 8 ,
100  .Xr pkg-updating 8 ,
101  .Xr pkg-upgrade 8 ,
102  .Xr pkg-version 8 ,
103  .Xr pkg-which 8