kore

An easy to use, scalable and secure web application framework for writing web APIs in C.
Commits | Files | Refs | README | LICENSE | git clone https://git.kore.io/kore.git

kodev.1 (4735B)



      1 .TH KODEV 1
      2 .SH NAME
      3 kodev \- Kore project management tool
      4 
      5 .SH SYNOPSIS
      6 .BR kodev
      7 [\fIOPTION\fR] ...
      8 
      9 .SH DESCRIPTION
     10 This documentation describes the application management tools for building and
     11 running a Kore project. For information regarding the technical interface and
     12 C bindings, look to
     13 .BR kore(3)
     14 where these functions and structures are described.
     15 .BR Kore
     16 projects may be managed using the following OPTIONS;
     17 
     18 .BR create
     19 .RS
     20 Create a new application skeleton with the name that is passed to it. This will
     21 create a new directory with all the files required to begin hacking. See the
     22 \fBGENERATED FILES\fR section for more information.
     23 .RE
     24 
     25 .BR build
     26 .RS
     27 Build the application. See the \fBBUILDING\fR section for more information.
     28 .RE
     29 
     30 .BR run
     31 .RS
     32 Start the application in the foreground. See the \fBRUNNING\fR section for
     33 more information.
     34 .RE
     35 
     36 .BR reload
     37 .RS
     38 Reload the application. This is a shortcut to sending SIGHUP to the parent
     39 process (see kore_pid).
     40 .RE
     41 
     42 .BR info
     43 .RS
     44 Show information about the application configuration. Namely; active flavor,
     45 output type, Kore features, Kore source and Kore binary.
     46 .RE
     47 
     48 .BR clean
     49 .RS
     50 Cleanup the build files.
     51 .RE
     52 
     53 .BR flavor
     54 .RS
     55 Switch between build flavors with the argument being the new flavor.
     56 .RE
     57 
     58 .BR help
     59 .RS
     60 Show the help synopsis.
     61 .RE
     62 
     63 .SH GENERATED FILES
     64 Executing the
     65 .BR create
     66 command will generate several new files under the directory matching the
     67 application name specified.
     68 
     69 These files are:
     70 
     71 .RS
     72 .BR conf/build.conf
     73 .RS
     74 The build configuration.
     75 .RE
     76 
     77 .BR conf/app.conf
     78 .RS
     79 The Kore application configuration.
     80 .RE
     81 
     82 .BR src/app.c
     83 .RS
     84 The initial placeholder source code.
     85 .RE
     86 
     87 .BR cert/server.pem
     88 .RS
     89 The self-signed auto-generated x509 certificate.
     90 .RE
     91 
     92 .BR cert/key.pem
     93 .RS
     94 The key matching the self-signed x509 certificate.
     95 .RE
     96 
     97 .BR dh2048.pem
     98 .RS
     99 The 2048-bit DH parameters used by TLS.
    100 .RE
    101 .RE
    102 
    103 Those files are:
    104 
    105 .RS
    106 .BR kore.conf
    107 .RS
    108 The Kore application configuration.
    109 .RE
    110 .RE
    111 
    112 .RS
    113 .BR handlers.py
    114 .RS
    115 The initial placeholder python page handler.
    116 .RE
    117 .RE
    118 
    119 .RS
    120 .BR __init__.py
    121 .RS
    122 The python initialization code. Sets up the kore listener, etc.
    123 .RE
    124 .RE
    125 
    126 .RS
    127 .BR cert/server.pem
    128 .RS
    129 The self-signed auto-generated x509 certificate.
    130 .RE
    131 .RE
    132 
    133 .RS
    134 .BR cert/key.pem
    135 .RS
    136 The key matching the self-signed x509 certificate.
    137 .RE
    138 .RE
    139 
    140 .RS
    141 .BR dh2048.pem
    142 .RS
    143 The 2048-bit DH parameters used by TLS.
    144 .RE
    145 .RE
    146 
    147 
    148 .SH BUILDING
    149 Executing the
    150 .BR build
    151 command will build your application. How this happens is instructed by
    152 the
    153 .BR conf/build.conf
    154 configuration file. This file supports the following directives:
    155 
    156 .RS
    157 .BR single_binary
    158 [yes|no]
    159 .RS
    160 If set to \fByes\fR the build system will produce a single binary containing
    161 both your application code and the Kore code allowing you to distribute
    162 your application more easily.
    163 
    164 If set to \fBno\fR the build system will produce a standard dynamically
    165 linked library that will be loaded into Kore at runtime.
    166 .RE
    167 .RE
    168 
    169 .RS
    170 .BR kore_source
    171 [path]
    172 .RS
    173 Must be set to point to the a Kore source code directory. Used only if
    174 .BR single_binary
    175 option is set to \fByes\fR.
    176 
    177 .BR Example:
    178 kore_source=/home/joris/src/kore
    179 .RE
    180 .RE
    181 .RE
    182 
    183 .RS
    184 .BR kore_flavor
    185 [build options]
    186 .RS
    187 Defines the build arguments for building Kore. Used only if
    188 .BR single_binary
    189 option is set to \fByes\fR.
    190 
    191 .BR Example:
    192 kore_flavor=NOTLS=1
    193 .RE
    194 .RE
    195 
    196 .RS
    197 .BR cflags
    198 .RS
    199 Standard
    200 .BR CFLAGS
    201 used when compiling the application source code.
    202 .RE
    203 .RE
    204 
    205 .RS
    206 .BR ldflags
    207 .RS
    208 Standard
    209 .BR LDFLAGS
    210 used when linking the application source code.
    211 .RE
    212 .RE
    213 
    214 Note that the
    215 .BR build
    216 command obeys the environment variables
    217 .BR CC
    218 and
    219 .BR CXX
    220 
    221 .SH RUNNING
    222 Executing the
    223 .BR run
    224 command will start your application in the foreground.
    225 
    226 What binary it executes depends
    227 on whether or not the
    228 .BR single_binary
    229 flag was set in build configuration. If the
    230 .BR single_binary
    231 flag was enabled the
    232 .BR run
    233 command will execute the binary produced by the build system. If the
    234 .BR single_binary
    235 flag was not enabled the
    236 .BR run
    237 command will execute the
    238 .BR $PREFIX/bin/kore
    239 binary.
    240 In both cases the
    241 .BR run
    242 command will pass the \fB\-fnr\fR command line options to the binary.
    243 .RE
    244 
    245 .SH EXAMPLES
    246 Changing flavor of the build;
    247 
    248 .RS
    249 $ kodev flavor osx
    250 .RE
    251 
    252 Building your application;
    253 
    254 .RS
    255 $ kodev build
    256 .RE
    257 
    258 .SH REPORTING BUGS, CONTRIBUTING && MORE
    259 If you run into any bugs, have suggestions or patches, please contact me at
    260 .BR <joris@coders.se>
    261 
    262 More information can be found at
    263 .BR <https://kore.io/>
    264 
    265 .SH AUTHOR
    266 .BR Kore
    267 developed by Joris Vink
    268 .BR <joris@coders.se>
    269 
    270 Manpage authored by Guy Nankivell
    271 .BR <guynankivell@gmail.com>
    272 
    273 .SH LICENCE
    274 Usage of this software is provided under the
    275 .BR ISC
    276 license which may be found, with the source, at
    277 .BR <https://github.com/jorisvink/kore>
    278