From b5bae7709a956f0a86e18bc4c666aa2a0566904b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 9 Mar 2023 19:28:41 +0000 Subject: doc: lei config: update with --edit and --list examples I typically use --edit/-e to make changes and --list/-l with git; and same with lei. --- Documentation/lei-config.pod | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/lei-config.pod b/Documentation/lei-config.pod index 663404fe..23a60c8a 100644 --- a/Documentation/lei-config.pod +++ b/Documentation/lei-config.pod @@ -4,7 +4,11 @@ lei-config - git-config wrapper for lei configuration file =head1 SYNOPSIS -lei config [OPTIONS] +lei config [[] []] + +lei config -l | --list + +lei config -e | --edit =head1 DESCRIPTION @@ -97,6 +101,27 @@ C, C, and C. =back +=head1 OPTIONS + +Most L command-line switches are accepted by C +as-is. The most-frequently-used options are expected to be: + +=over 4 + +=item -e + +=item --edit + +Opens an editor to edit the lei config file + +=item -l + +=item --list + +List all variables set in config file, along with their values. + +=back + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -106,6 +131,6 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L -- cgit v1.2.3-24-ge0c7