summary refs log tree commit diff
diff options
context:
space:
mode:
authorfigsoda <figsoda@pm.me>2021-08-19 13:47:07 -0400
committerfigsoda <figsoda@pm.me>2021-08-19 14:00:04 -0400
commit4b93f966c5c1d006404ee49e57e123ccb840a4b6 (patch)
tree66142df82f30ba05988dbcd1e00ca3e42967499c
parentaa045621af26840816c7760f0e0f3d41e91dfaa8 (diff)
downloadnixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar.gz
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar.bz2
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar.lz
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar.xz
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.tar.zst
nixpkgs-4b93f966c5c1d006404ee49e57e123ccb840a4b6.zip
doc: stdenv: document meta.mainProgram
-rw-r--r--doc/stdenv/meta.chapter.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md
index e4970f7e964..ac518cee524 100644
--- a/doc/stdenv/meta.chapter.md
+++ b/doc/stdenv/meta.chapter.md
@@ -114,6 +114,10 @@ For details, see [Licenses](#sec-meta-license).
 
 A list of the maintainers of this Nix expression. Maintainers are defined in [`nixpkgs/maintainers/maintainer-list.nix`](https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix). There is no restriction to becoming a maintainer, just add yourself to that list in a separate commit titled “maintainers: add alice”, and reference maintainers with `maintainers = with lib.maintainers; [ alice bob ]`.
 
+### `mainProgram` {#var-meta-mainProgram}
+
+The name of the main binary for the package. This effects the binary `nix run` executes and falls back to the name of the package. Example: `"rg"`
+
 ### `priority` {#var-meta-priority}
 
 The *priority* of the package, used by `nix-env` to resolve file name conflicts between packages. See the Nix manual page for `nix-env` for details. Example: `"10"` (a low-priority package).