From 1c13ae4ed5d84b32c2c1a0698f9e688c312de989 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Mon, 11 Jan 2016 15:14:32 +0200 Subject: Documentation improvements --- bpkg/pkg-build.cli | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) (limited to 'bpkg/pkg-build.cli') diff --git a/bpkg/pkg-build.cli b/bpkg/pkg-build.cli index 54e0252..aa16f58 100644 --- a/bpkg/pkg-build.cli +++ b/bpkg/pkg-build.cli @@ -6,7 +6,7 @@ include ; "\section=1" "\name=bpkg-pkg-build" -"\summary=build one or more packages" +"\summary=build package" namespace bpkg { @@ -15,19 +15,22 @@ namespace bpkg "\h|SYNOPSIS| - \c{\b{bpkg pkg-build} [] ([/] | | )...} + \c{\b{bpkg pkg-build}|\b{build} [] ([/] | | )...} \h|DESCRIPTION| The \cb{pkg-build} command builds one or more packages including all their prerequisites. Each package can be specified as just the name () with optional package version () in which case the package will be - automatically fetched from one of the configuration's source repositories - (see the \cb{cfg-add} and \cb{cfg-fetch} commands). Alternatively, the - package can be specified as either the path to the package source archive - () or package source directory (). See the \cb{pkg-fetch} and - \cb{pkg-unpack} commands for more information on the semantics of - specifying the package as an archive or directory. + automatically fetched from one of the repositories. See the + \l{bpkg-cfg-add(1)} and \l{bpkg-cfg-fetch(1)} commands for more + information on package repositories. + + Alternatively, the package can be specified as either the path to the + package archive () or to the package directory (). See the + \l{bpkg-pkg-fetch(1)} and \l{bpkg-pkg-unpack(1)} commands for more + information on the semantics of specifying the package as an archive or + a directory. Packages that are specified explicitly on the command line will be \i{held}, that is, they will not be considered for automatic removal if @@ -49,15 +52,15 @@ namespace bpkg "Assume the answer to all prompts is \cb{yes}." } - bool --configure-only|-c - { - "Configure all the packages but don't update." - } - bool --print-only|-p { "Print to \cb{STDOUT} what would be done without actually doing anything." } + + bool --configure-only|-c + { + "Configure all the packages but don't update." + } }; } -- cgit v1.1