slp/slp.1

65 lines
1.3 KiB
Groff
Raw Normal View History

.TH "slp" 1 "20 AUG 2021" "" "General Operation Manual"
.SH NAME
\fBslp\fP - (sl)ope (p)ackage manager
.SH SYNOPSIS
.nf
.fam C
\fBslp\fP [\fIargs\fP...]
.fam T
.fi
.SH DESCRIPTION
\fBslp\fP is a basic package management system for the slope programming language.
.SH OPTIONS
.TP
.B
\fBhelp\fP
Display usage help and exit. Provides a list of all command line options with a short description and exits.
.TP
.B
\fBlist\fP
Display a list of \fIall\fP packages in the registry
.TP
.B
2021-08-27 06:11:23 +00:00
\fBgen\fP
Generate a new project folder with module.json and main.slo files
.TP
.B
2021-09-03 21:54:33 +00:00
\fBinstalled\fP
Display a list of the \fIcurrently installed\fP modules
.TP
.B
2021-08-27 06:11:23 +00:00
\fBdocs [module]\fP
View the given module's README file, if one exists. Only works for local modules
.TP
.B
\fB+<package>\fP
2021-08-27 06:11:23 +00:00
Installs \fI<package>\fP
.TP
.B
\fB-<package>\fP
2021-08-27 06:11:23 +00:00
Removes \fI<package>\fP
.TP
.B
\fB^<package>\fP
2021-08-27 06:11:23 +00:00
Updates \fI<package>\fP
.TP
.B
\fB@<package>\fP
Show information about \fI<package>\fP
.TP
.B
\fB?<term>\fP
Searches for \fI<term>\fP in the package registry and displays matching results
.SH BUGS
There are bugs. Have fun!
.SH LINKS
\fBslp\fP maintains a presence in the following locations:
.TP
.B
Source Code Repository
https://git.rawtext.club/slope-lang/slp
.SH AUTHORS
\fBslp\fP is developed by sloum
.TP
Based on existing work by Zac Garby (see LICENSE)