package calculon

You can search for identifiers within the package.

in-package search v0.2.0

package calculon

calculon
- Calculon
  - Command
  - Config
  - Core
    
    S
  - Log
  - Lwt_err
  - Plugin
    
    Set
  - Plugin_factoids
  - Plugin_history
  - Plugin_social
  - Plugin_state
  - Plugin_vote
  - Prelude
    
    Rand_distrib
    
    StrMap
  - Run_main
  - Signal
    
    Send_ref
  - Talk
calculon.extras
- Calculon_extras
  - Irclog
  - Plugin_markcough
    
    Gen
    
    Parse_logs
    
    Table

Legend:
Library
Module
Module type
Parameter
Class
Class type

User-defined config

type irc_log = [

| `None
| `Chan of Lwt_io.output_channel
| `Custom of string -> unit Lwt.t

]

type t = {

server : string;
(*
Address of the irc server
*)
port : int;
(*
Port of the server
*)
username : string;
realname : string;
nick : string;
tls : bool;
tls_cert : Tls.Config.certchain option;
channel : string;
(*
Channel to join after the connexion to the server
*)
state_file : string;
(*
Where plugins' state is stored
*)
irc_log : irc_log;
(*
Log IRC events
*)
prefix : string;
(*
prefix for commands
*)

}

val default : t

Default configuration:

server = "irc.freenode.net"
port = 7000
username = "calculon"
realname = "calculon"
nick = "calculon"
tls = true
tls_cert = None
channel = "#ocaml"
state_file = "state.json"
irc_log = `None
prefix = "!"

val parse : t -> string array -> t

parse conf args is the same as conf, but some command line arguments can override its fields

val of_argv : unit -> t

Parsed from Sys.argv Will call exit if Arg.parse fails