man/kiwiirc.1

   1 .TH KIWIIRC 1
   2 .SH NAME
   3 kiwiirc \- the Kiwi IRC web client
   4 .SH SYNOPSIS
   5 .B kiwiirc
   6 [\fB\-f\fR | \fBstart\fR | \fBstop\fR | \fBrestart\fR | \fBstatus\fR | \fBreconfig\fR | \fBbuild\fR] [\fB\-c\fR\ \fIconfig_file\fR] [\fB\-p\fR\ \fIpid_file\fR]
   7 .SH DESCRIPTION
   8 Kiwi IRC is a web-based IRC client built using Node.js.
   9 .SH OPTIONS
  10 .TP
  11 .BR \-f\fR
  12 Run the kiwi server in the foreground. When run in the foreground kiwi will print all logs to stdout.
  13 .TP
  14 .BR start\fR
  15 Start the kiwi server and fork in to the background.
  16 .TP
  17 .BR stop\fR
  18 Stop the kiwi server if it is running.
  19 .TP
  20 .BR restart\fR
  21 Restart the kiwi server. If it is not running, it will be started.
  22 .TP
  23 .BR status\fR
  24 Output to stdout whether the kiwi server is running or not. If it is running it will also display the server's PID.
  25 .TP
  26 .BR reconfig\fR
  27 Forces the kiwi server to re-load its configuration file by sending the process \fBSIGUSR1\fR.
  28 .TP
  29 .BR build\fR
  30 Builds the necessary client files. This will process translation files, build the HTML file and bundle and minify the client-side JavaScript code.
  31 .TP
  32 .BR \-c\fR\ \fIconfig_file\fR
  33 Use the specified \fIconfig_file\fR instead of searching the pre-defined locations. By default the kiwi server will look in \fI/etc/kiwiirc\fR and the installation directory for a configuration file named \fIconfig.js\fR.
  34 .TP
  35 .BR \-p\fR\ \fIpid_file\fR
  36 Write the kiwi server's PID to this file. By default, kiwi will write the PID to a file called \fIkiwiirc.pid\fR in the installation directory unless it is started with the \fB\-f\fR flag.
  37 .SH FILES
  38 .TP
  39 .IR /etc/kiwiirc/config.js
  40 If this file exists, and the \fB\-c\fR option has not been specified, kiwi will use this file as its configuration file. If it does not exist, kiwi will try to locate \fIconfig.js\fR in its installation directory.
  41 .SH BUGS
  42 Please report bugs on the GitHub issues page at
  43 .UR https://github.com/prawnsalad/KiwiIRC/issues
  44 .UE
  45 or on the mailing list at
  46 .MT kiwiirc@googlegroups.com
  47 .ME .