forked from mirrors/kore
More comprehensive page detailing configurations
This commit is contained in:
parent
66e9f4db77
commit
5ec94965eb
|
@ -7,28 +7,43 @@ kodev \- Kore project management tool
|
||||||
[\fIOPTION\fR] ...
|
[\fIOPTION\fR] ...
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
kore projects may be managed using the following OPTIONS;
|
This documentation describes the application management tools for building and
|
||||||
|
running a kore project. For information regarding the technical interface and
|
||||||
|
C bindings, look to
|
||||||
|
.BR KORE(3)
|
||||||
|
where these functions and structures are described.
|
||||||
|
.BR kore
|
||||||
|
projects may be managed using the following OPTIONS;
|
||||||
|
|
||||||
.BR help
|
.BR create
|
||||||
.RS
|
.RS
|
||||||
Show the help synopsis.
|
Create a new application skeleton with the name that is passed to it. This will
|
||||||
.RE
|
create a new directory with all the files required to begin hacking about.
|
||||||
|
This will also generate a self-signed certificate \fIunless\fR \fBkore\fR was
|
||||||
.BR run
|
built with \fBNOTLS=1\fR. Note this certificate should not be used for
|
||||||
.RS
|
production.
|
||||||
Run an application (\-fnr implied). The current directory is the path of the
|
|
||||||
project to be run.
|
|
||||||
.RE
|
|
||||||
|
|
||||||
.BR reload
|
|
||||||
.RS
|
|
||||||
Reload the application (SIGHUP sent).
|
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.BR build
|
.BR build
|
||||||
.RS
|
.RS
|
||||||
Build the application. The properties of this build are read from
|
Build the application. The properties of this build are read from
|
||||||
.BR conf/build.conf
|
.BR conf/build.conf
|
||||||
|
and the semantics of which are discussed in \fBCONFIGURATION FILES\fR
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.BR run
|
||||||
|
.RS
|
||||||
|
Run an application (\-fnr implied). The current directory is the path of the
|
||||||
|
project to be run. This will read from the \fBconf/app.conf\fR discussed in
|
||||||
|
\fBCONFIGURATION FILES\fR unless otherwise specified. This will build the
|
||||||
|
application\-\-if necessary\-\-and start it in the foregound. \fB^C\fR
|
||||||
|
will stop the process.
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.BR reload
|
||||||
|
.RS
|
||||||
|
Reload the application (SIGHUP sent). Reads the application run configuration
|
||||||
|
which would be read in a normal run on a reload.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.BR info
|
.BR info
|
||||||
|
@ -42,16 +57,16 @@ features, kore source and kore binary.
|
||||||
Cleanup the build files.
|
Cleanup the build files.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.BR create
|
|
||||||
.RS
|
|
||||||
Create a new application skeleton with the name that is passed to it.
|
|
||||||
.RE
|
|
||||||
|
|
||||||
.BR flavour
|
.BR flavour
|
||||||
.RS
|
.RS
|
||||||
Switch between build flavours with the argument being the new flavour.
|
Switch between build flavours with the argument being the new flavour.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
|
.BR help
|
||||||
|
.RS
|
||||||
|
Show the help synopsis.
|
||||||
|
.RE
|
||||||
|
|
||||||
.BR \-p
|
.BR \-p
|
||||||
.RS
|
.RS
|
||||||
Option used in conjunction with \fBcreate\fR to generate an application for use
|
Option used in conjunction with \fBcreate\fR to generate an application for use
|
||||||
|
@ -59,6 +74,39 @@ with
|
||||||
.BR pyko
|
.BR pyko
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
|
.SH CONFIGURATION FILES
|
||||||
|
When one calls a \fBbuild\fR on the application, it will read the
|
||||||
|
.BR conf/build.conf.
|
||||||
|
This defines attributes of the build such as whether you wish to produce a
|
||||||
|
single binary instead of a dynamic library. If you choose to do so, also
|
||||||
|
ensure to set
|
||||||
|
.BR kore_source
|
||||||
|
and
|
||||||
|
.BR kore_flavour
|
||||||
|
and update the \fBldflags\fR to include the appropriate libraries you intend
|
||||||
|
to link the binary with. You may also set custom \fBcflags\fR either global to
|
||||||
|
the flavours or per flavour configurations.
|
||||||
|
|
||||||
|
When a \fBcreate [app]\fR is called, kodev will also create an \fBapp.conf\fR
|
||||||
|
where 'app' is the name of the project. This configuration describes to Kore
|
||||||
|
what modules to load, how validators work, what page handlers to map and which
|
||||||
|
functions and more. Technical documentation regarding the specifics of this
|
||||||
|
may be found in
|
||||||
|
.BR KORE(3)
|
||||||
|
|
||||||
|
.SH EXAMPLES
|
||||||
|
Changing flavour of the build;
|
||||||
|
|
||||||
|
.RS
|
||||||
|
kodev flavor osx
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Creating a new application 'app' with \fBpyko\fR support;
|
||||||
|
|
||||||
|
.RS
|
||||||
|
kodev create \-p app
|
||||||
|
.RE
|
||||||
|
|
||||||
.SH REPORTING BUGS, CONTRIBUTING && MORE
|
.SH REPORTING BUGS, CONTRIBUTING && MORE
|
||||||
If you run into any bugs, have suggestions or patches, please contact me at
|
If you run into any bugs, have suggestions or patches, please contact me at
|
||||||
.BR <joris@coders.se>
|
.BR <joris@coders.se>
|
||||||
|
@ -79,3 +127,4 @@ Usage of this software is provided under the
|
||||||
.BR ISC
|
.BR ISC
|
||||||
license which may be found, with the source, at
|
license which may be found, with the source, at
|
||||||
.BR <https://github.com/jorisvink/kore>
|
.BR <https://github.com/jorisvink/kore>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue