mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-11-19 15:14:48 +00:00
Code Issues 1 Releases Wiki Activity

Merge pull request #472 from uvtc/patch-1

Browse Source 
fix jpm.1 typos
This commit is contained in:
Calvin Rose 2020-09-18 20:19:22 -05:00 committed by GitHub
commit ceba1ba4ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jpm.1
View File

@ -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 Sets the C compiler used for compiling native modules and standalone executables. Defaults
to cc. to cc.
.TP
.BR \-\-cpp\-compiler=$CXX .BR \-\-cpp\-compiler=$CXX
Sets the C++ compiler used for compiling native modules and standalone executables. Defaults Sets the C++ compiler used for compiling native modules and standalone executables. Defaults
to c++.. to c++..
@ -105,7 +106,6 @@ be created in the ./build/ directory.
.TP .TP
.BR install\ [\fBrepo...\fR] .BR install\ [\fBrepo...\fR]
When run with no arguments, installs all installable artifacts in the current project to 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 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. 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 .TP
.BR uninstall\ [\fBname...\fR] .BR uninstall\ [\fBname...\fR]
Uninstall a project installed with install. uninstall expects the name of the project, not the 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 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. 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. List all installed packages in the current syspath.
.TP .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. 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. 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. List all rules that can be run via run. This is useful for exploring rules in the project.
.TP .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 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 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. 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 Update the package listing by installing the 'pkgs' package. Same as jpm install pkgs
.TP .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. 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 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 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 .RS
The location that jpm will use to install libraries to. Defaults to JANET_PATH, but you could 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 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. This variable is overwritten by the --modpath=/some/path if it is provided.
.RE .RE
@ -238,7 +238,7 @@ variable.
.B JANET_LIBPATH .B JANET_LIBPATH
.RS .RS
Similar to JANET_HEADERPATH, this path is where jpm will look for 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. set on a normal install.
If not provided, this will default to <jpm script location>/../lib. If not provided, this will default to <jpm script location>/../lib.
The --libpath=/some/path option will override this variable. 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 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 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. can be used to choose a particular set of dependency versions for a whole project.
.RE
.B JANET_GIT .B JANET_GIT
.RS .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 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. if you have a normal install of git.
.RE
.SH AUTHOR .SH AUTHOR
Written by Calvin Rose <calsrose@gmail.com> Written by Calvin Rose <calsrose@gmail.com>