Skip to content

Commit 0b1de7b

Browse files
committed
Update man page with changes to other documentation
1 parent 964b0e7 commit 0b1de7b

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

doc/man/zkg.1

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
3-
.TH "ZKG" "1" "Jun 23, 2023" "2.13.0-32" "Zeek Package Manager"
3+
.TH "ZKG" "1" "Jun 30, 2023" "2.13.0-32" "Zeek Package Manager"
44
.SH NAME
55
zkg \- Zeek Package Manager
66
.
@@ -62,7 +62,7 @@ See \fI\%Config File\fP\&.
6262
Store all state in user\(aqs home directory. Precludes \-\-configfile.
6363
.TP
6464
.B \-\-verbose=0\fP,\fB \-v=0
65-
Increase program output for debugging. Use multiple times for more output (e.g. \-vvv).
65+
Increase program output for debugging. Use multiple times for more output (e.g. \-vv).
6666
.TP
6767
.B \-\-extra\-source
6868
Add an extra source.
@@ -326,7 +326,7 @@ usage: zkg refresh [\-h] [\-\-aggregate] [\-\-fail\-on\-aggregate\-problems] [\-
326326
.INDENT 7.0
327327
.TP
328328
.B \-\-aggregate=False
329-
Crawls the urls listed in package source zkg.index files and aggregates the metadata found in their zkg.meta (or legacy bro\-pkg.meta) files. The aggregated metadata is stored in the local clone of the package source that zkg uses internally for locating package metadata. For each package, the metadata is taken from the highest available git version tag or the default branch, like "main" or "master", if no version tags exist
329+
Crawls the urls listed in package source zkg.index files and aggregates the metadata found in their zkg.meta files. The aggregated metadata is stored in the local clone of the package source that zkg uses internally for locating package metadata. For each package, the metadata is taken from the highest available git version tag or the default branch, like "main" or "master", if no version tags exist
330330
.TP
331331
.B \-\-fail\-on\-aggregate\-problems=False
332332
When using \-\-aggregate, exit with error when any packages trigger metadata problems. Normally such problems only cause a warning.
@@ -499,7 +499,7 @@ Outputs a list of packages that match a given category.
499499
.sp
500500
.nf
501501
.ft C
502-
usage: zkg list [\-h] [\-\-nodesc] [{all,installed,not_installed,loaded,unloaded,outdated}]
502+
usage: zkg list [\-h] [\-\-nodesc] [\-\-include\-builtin] [{all,installed,not_installed,loaded,unloaded,outdated}]
503503
.ft P
504504
.fi
505505
.UNINDENT
@@ -520,6 +520,9 @@ Possible choices: all, installed, not_installed, loaded, unloaded, outdated
520520
.TP
521521
.B \-\-nodesc=False
522522
Do not display description text, just the package name(s).
523+
.TP
524+
.B \-\-include\-builtin=False
525+
Also output packages that Zeek has built\-in. By default these are not shown.
523526
.UNINDENT
524527
.UNINDENT
525528
.SS search
@@ -554,7 +557,8 @@ Shows detailed information/metadata for given packages. If the package is curren
554557
.sp
555558
.nf
556559
.ft C
557-
usage: zkg info [\-h] [\-\-version VERSION] [\-\-nolocal] [\-\-json] [\-\-jsonpretty SPACES] [\-\-allvers]
560+
usage: zkg info [\-h] [\-\-version VERSION] [\-\-nolocal] [\-\-include\-builtin] [\-\-json] [\-\-jsonpretty SPACES]
561+
[\-\-allvers]
558562
package [package ...]
559563
.ft P
560564
.fi
@@ -578,6 +582,9 @@ The version of the package metadata to inspect. A version tag, branch name, or
578582
.B \-\-nolocal=False
579583
Do not read information from locally installed packages. Instead read info from remote GitHub.
580584
.TP
585+
.B \-\-include\-builtin=False
586+
Also output packages that Zeek has built\-in. By default these are not shown.
587+
.TP
581588
.B \-\-json=False
582589
Output package information as JSON.
583590
.TP
@@ -776,7 +783,7 @@ state_dir =
776783
# A subdirectory named "packages" is always created within the
777784
# specified path and the package manager will copy the directory
778785
# specified by the "script_dir" option of each package\(aqs zkg.meta
779-
# (or legacy bro\-pkg.meta) file there.
786+
# file there.
780787
# If left blank or with \-\-user this defaults to <state_dir>/script_dir.
781788
# In Zeek\-bundled installations, it defaults to
782789
# <zeek_install_prefix>/share/zeek/site.
@@ -789,7 +796,7 @@ script_dir =
789796
# A subdirectory named "packages" is always created within the
790797
# specified path and the package manager will copy the directory
791798
# specified by the "plugin_dir" option of each package\(aqs zkg.meta
792-
# (or legacy bro\-pkg.meta) file there.
799+
# file there.
793800
# If left blank or with \-\-user this defaults to <state_dir>/plugin_dir.
794801
# In Zeek\-bundled installations, it defaults to
795802
# <zeek_install_prefix>/lib/zeek/plugins.
@@ -808,7 +815,8 @@ bin_dir =
808815

809816
# The directory containing Zeek distribution source code. This is only
810817
# needed when installing packages that contain Zeek plugins that are
811-
# not pre\-built.
818+
# not pre\-built. This value is generally not needed by most users other
819+
# than plugin developers anymore.
812820
zeek_dist =
813821

814822
[templates]
@@ -819,13 +827,13 @@ default = https://github.com/zeek/package\-template
819827

820828
[user_vars]
821829

822-
# For any key in this section that is matched for value interpolation
823-
# in a package\(aqs zkg.meta (or legacy bro\-pkg.meta) file, the corresponding
824-
# value is substituted during execution of the package\(aqs \(gabuild_command\(ga.
825-
# This section is typically automatically populated with the
826-
# the answers supplied during package installation prompts
827-
# and, as a convenience feature, used to recall the last\-used settings
828-
# during subsequent operations (e.g. upgrades) on the same package.
830+
# For any key in this section that is matched for value interpolation in a
831+
# package\(aqs zkg.meta file, the corresponding value is substituted during
832+
# execution of the package\(aqs \(gabuild_command\(ga. This section is typically
833+
# automatically populated with the the answers supplied during package
834+
# installation prompts and, as a convenience feature, used to recall the
835+
# last\-used settings during subsequent operations (e.g. upgrades) on the same
836+
# package.
829837

830838
.ft P
831839
.fi

0 commit comments

Comments
 (0)