From 468e13501c09802cf05ac4a00aeaa4594f01b998 Mon Sep 17 00:00:00 2001 From: John Gabriele Date: Tue, 15 Sep 2020 00:06:09 -0400 Subject: [PATCH] Update jpm.1 Fix some typos. --- jpm.1 | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/jpm.1 b/jpm.1 index 53204195..3bf4dc1c 100644 --- a/jpm.1 +++ b/jpm.1 @@ -74,6 +74,7 @@ $JANET_LIBPATH, or a reasonable default. See JANET_LIBPATH for more. Sets the C compiler used for compiling native modules and standalone executables. Defaults to cc. +.TP .BR \-\-cpp\-compiler=$CXX Sets the C++ compiler used for compiling native modules and standalone executables. Defaults to c++.. @@ -105,7 +106,6 @@ be created in the ./build/ directory. .TP .BR install\ [\fBrepo...\fR] - When run with no arguments, installs all installable artifacts in the current project to the current JANET_MODPATH for modules and JANET_BINPATH for executables and scripts. Can also take an optional git repository URL and will install all artifacts in that repository instead. @@ -115,7 +115,7 @@ install multiple dependencies in one command. .TP .BR uninstall\ [\fBname...\fR] Uninstall a project installed with install. uninstall expects the name of the project, not the -repository url, path to installed file or executable name. The name of the project must be specified +repository url, path to installed file, or executable name. The name of the project must be specified at the top of the project.janet file in the declare-project form. If no name is given, uninstalls the current project if installed. Will also uninstall multiple packages in one command. @@ -148,7 +148,7 @@ required. List all installed packages in the current syspath. .TP -.BR list-pkgs [\fBsearch\fR] +.BR list-pkgs\ [\fBsearch\fR] List all package aliases in the current package listing that contain the given search string. If no search string is given, prints the entire listing. @@ -172,7 +172,7 @@ like make. run will run a single rule or build a single file. List all rules that can be run via run. This is useful for exploring rules in the project. .TP -.BR rule-tree\ [\fBroot\fR] [\fdepth\fR] +.BR rule-tree\ [\fBroot\fR]\ [\fBdepth\fR] Show rule dependency tree in a pretty format. Optionally provide a rule to use as the tree root, as well as a max depth to print. By default, prints the full tree for all rules. This can be quite long, so it is recommended to give a root rule. @@ -186,7 +186,7 @@ Show all of the paths used when installing and building artifacts. Update the package listing by installing the 'pkgs' package. Same as jpm install pkgs .TP -.BR quickbin [\fBentry\fR] [\fBexecutable\fR] +.BR quickbin\ [\fBentry\fR]\ [\fBexecutable\fR] Create a standalone, statically linked executable from a Janet source file that contains a main function. The main function is the entry point of the program and will receive command line arguments as function arguments. The entry file can import other modules, including native C modules, and @@ -222,7 +222,7 @@ the default location set at compile time, which can be determined with (dyn :sys .RS The location that jpm will use to install libraries to. Defaults to JANET_PATH, but you could set this to a different directory if you want to. Doing so would let you import Janet modules -on the normal system path (JANET_PATH or (dyn :syspath)), but install to a different directory. It is also a more reliable way to install +on the normal system path (JANET_PATH or (dyn :syspath)), but install to a different directory. It is also a more reliable way to install. This variable is overwritten by the --modpath=/some/path if it is provided. .RE @@ -238,7 +238,7 @@ variable. .B JANET_LIBPATH .RS Similar to JANET_HEADERPATH, this path is where jpm will look for -libjanet.a for creating standalong executables. This does not need to be +libjanet.a for creating standalone executables. This does not need to be set on a normal install. If not provided, this will default to /../lib. The --libpath=/some/path option will override this variable. @@ -257,11 +257,13 @@ The --binpath=/some/path will override this variable. The git repository URL that contains a listing of packages. This allows installing packages with shortnames, which is mostly a convenience. However, package dependencies can use short names, package listings can be used to choose a particular set of dependency versions for a whole project. +.RE .B JANET_GIT .RS An optional path to a git executable to use to clone git dependencies. By default, uses "git" on the current $PATH. You shouldn't need to set this if you have a normal install of git. +.RE .SH AUTHOR Written by Calvin Rose