Index of values

The infix operator x $ y concatenates two documents x and y into a larger one.

Instead of writing x $ break $ y to insert a break it is convenient to define an operator for this: x ^/ y joins x and y with a break.

Joins two documents with a break_null.

(name %: typ) specifies a required anonymous argument of type typ.

spec1 ++ spec2 composes command-line specifications spec1 and spec2.

specification composition: spec1 ++ spec2 ++ ... specN is the way composition.

alias for sprintf

alias for String.concat

specifies an exact usage message for a sequence of anonymous strings

add m ~key ~data adds the key to the value already bound to key in m.

add_substring b s ofs len takes len characters from offset ofs in string s and appends them at the end of the buffer b.

The automatic group agrp is the most versatile.

all_levs array of all logging levels sorted in ascending order.

all_same hunk returns true if hunk contains only Same ranges.

get_status hunks returns `Same if each hunk in hunks has only Same ranges.

all_str_levs array of all logging levels as strings sorted in ascending order.

anon spec specifies a command that, among other things, takes the anonymous arguments specified by spec.

an action for a flag that takes an additional string argument

an argument type includes information about how to parse values of that type from the command line, and (optionally) how to auto-complete partial arguments of that type via bash's programmable TAB-completion.

atomic_edit ~f filepath edit filepath by making a unique copy (peer) that can be openly changed without holding any locks on the original.

create actions command_line gets the completion suggestions that bash's compgen would generate for the selected actions and the last word of the command_line.

basic ~summary ?readme spec main is a basic command that executes a function main which is passed parameters parsed from the command line according to spec.

A block contains objects xs formatted by f and enclosed by curly braces.

an action for a flag that takes an additional bool argument

The important points in a document are so-called breaks.

break_null behaves like break except it does not insert anything when no newline is inserted.

The space character used by break my be not always appropriate.

btry_wrap_r_lock mtx f tries to lock mtx for a reader without blocking, executes f and unlocks the mutex again.

compare two buffer fragments

call f on channel until End_of_file

create a progress function for an input channel

checked_edit ~check file

classify l ~equal ~f elements x and y of list l are assigned to the same class iff equal (f x) (f y) returns true.

Remove all the values from the store.

Inform the strategy that all the elements where dropped from the store.

clear t set the contents of every element to false O(n / (word_size - 2))

removes the filter from a log

Closes the line buffer (and the underlying file).

close t drops all the resources associated with t.

collate s1 s2 sorts string in an order that's is usaully more suited for human consumption by treating ints specificaly: (e.g.

Provides a "version" subcommand.

Takes a string and returns the same string but commented according to sexp's syntax

Filename.compare is a comparaison that normalizes filenames ("./a" = "a") use a more human ready algorithm based on String.collate ("rfc02.txt > rfc1.txt") and extenstions ("a.c" > "a.h").

compare_lev lev1 lev2 compares logging levels lev1 and lev2.

concatenate a list of iterators

Prompts for an answer.

Connect a socket with a connect timeout

Consolidates a list of strings (almost ^) losslessly.

Consolidates a list of strings in such a way that the result does not exceed the given length.

const v inserts v as a hard-coded argument to the command.

copies data from one array to another.

cps_create is given in CPS form to enable chaining.

cps_create ~f is given in CPS form to enable chaining.

create ~eol f Create a new line buffer where f will be called once on every line.

create dist compiles a discrete probability distribution into a form supporting constant-time sampling.

create pref

- max_size - the maximum size of each log file (default 50Mb) mode - mode to open the files in, max_archives - maximum number of archives to keep (default 4), full_callback - called when the logger queue backs up so far that log items may have been lost. Defaults to doing nothing., filter - if set, then every message is passed to filter before actually being logged. If filter returns false the message is dropped., message_to_string - called to convert your message type to a string for logging

Open a line buffer from the passed filename.

create ?options dir create a Find.t based in dir

create should not be called more than once

create size size must be less than ((word size - 2) * max array length)

creates a column given the header and the to-string function

like create, except that the to_string function must provide a list of attributes.

creates a log using the default message type and a filter that drops `Debug messages

Fraction of maximum number of descriptors considered critical.

data store returns all values in store.

rest f: a flag that signals the end of flag processing.

rest f: a flag that signals the end of flag processing.

diff s1 s2 returns diff (1) output of the two strings.

drop stuff from the end.

Gives the Levenshtein distance between 2 strings, which is the number of insertions, deletions, and substitutions necessary to turn either string into the other.

The empty document is pretty printed to the empty string.

an iterator that halts immediately

A map containing no bindings

ensure_at_exit (): catch all signals, run at_exit functions, then re-deliver the signal to self to ensure the default behavior.

enumerate_from n xs returns a list of pairs constructed by pairing an incrementing counter, starting at n, with the elements of xs.

escape flags may be passed at most once.

Escape a CSV (even if doesn't have any characters that require escaping).

esyslog ?fac ?lev str same as Syslog.syslog, but also prints to stderr.

esyslog_printf ?fac ?lev fmt same as Syslog.syslog_printf, but also prints to stderr.

expand Makes a path absolute and expands ~ ~username to home directories.

double the size of the buffer

Splits a given path in a list of strings.

variable used by dispatch command to find binaries not in the path.

The folding function.

The break policy inside an agrp is fixed for all breaks of the group.

Sets the filter for a log

iterate over elements that satisfy the predicate

find m key returns all the elements that where added to key in m in the reverse order in which they where added.

find an element that satisfies the predicate

find store key returns the value associated to key in store.

find_all ?options dir short for to_list (create ?options dir)

flag name spec ~doc specifies a command that, among other things, takes a flag named name on its command line.

an action for a flag that takes an additional float argument

flush b Flushes any pending output to the callback function.

fold is the same as reduce

fold t ~init ~f folds f over the files in t

fold t ~init ~f Fold over the array as in Array.fold

fold_left_term is like fold_left, except that you can halt early.

evaluate a predicate over the entire iterator

Force the lazy value.

fork_exec prog args ~stdin ~stdout ~stderr ~setuid ~setgid forks a new process that executes the program in file prog, with arguments args.

Shortcut for calling Core_extended.Unix.strftime without having to create a Time.t and convert it to a Unix.tm.

A version of Memo.general more suitable for memoizing recursively-defined functions

update_exn updates a Cpu_use.t.

get sem

get t pos get the value in position pos, raises Invalid_argument if the position is out of bounds.

get_all_procs returns a list of all processes on the system

Get the default editor (program) for this user.

get_hunks a b ~context ~compare will compare the arrays a and b using compare and produce a list of hunks.

Get minimum log level

Analogous to get_editor, defaulting to a list including less and more.

get_ppids pid returns the list of parent pids, up to init (1) for pid.

get_ip_from_hostname () returns the IP of the current host by resolving the hostname.

get load averages

group ~summary subcommand_alist is a compound command with named subcommands, as found in subcommand_alist.

group ~summary [...; (name_i, t_i); ...] is an aggregate command that dispatches to one of the named sub-commands.

Get the names of the groups the user belongs to

Get hostname from sockaddr

Get hostname or (on Not_found) inet string from sockaddr

A group operator takes a document and let it become a group.

 hlist [x1,..,xn] = hgrp [x1; break; x2; ...; break; xn) 

Get the home of the effective user

iterate over the iterator: call f on each element

ifconfig_ips () returns IPs of all active interfaces on the host by parsing ifconfig output.

dual to explode

Get inet_addr from sockaddr

init v initializes a semaphore with an optional value v.

The initial value of the accumulator.

an action for a flag that takes an additional int argument

intersperse returns a list with the given element placed between every two original elements.

Returns whether or not the line buffer is closed

is_substring ~substring t returns true if substring is a substring of t.

Returns true if the lazy value has been forced and did not throw an exception.

iter t ~f calls f on every file in t

iter buf ~f calls func on each buffer element starting with 0 like this: (func pos element)

iter t ~f Iterate over the array as in Array.iter

iterr buf ~f calls func on each buffer element starting with end like this: (func pos element)

jiffies_per_second_exn.

Returns all the non-empty keys in m.

kills a process by sending signal; waiting for wait_for and then sending a sigkill.

last_accessed path returns the time path was last accessed.

last_changed path returns the time path last had its status changed.

last_modify path returns the time the file at path was last modified.

Find the longest common subsequence between two list.

lev_of_string str converts string str to a level.

lift t ~project transforms a flag with accumulator type 'a into a flag with a more informative accumulator type 'b provided that project x returns a pair consisting of 1.

deprecated in favour of word_wrap

Convert one CSV line to a string.

A list of objects which are seperated by some seperator is very common.

listed flags may be passed zero or more times

loadavg_exn parses /proc/loadavg.

logs a message to log

make_absolute src Turn src in an absolute path expanded from the current working directory.

make_flags ar

make_relative ~to_:src f returns f relative to src.

mallinfo ()

malloc_stats () prints brief summary statistics on stderr.

malloc_trim n release all but n bytes of freed top-most memory back to the system.

mallopt opt n sets malloc configuration option opt to n.

transform the iterator

match_ t pulls out the underlying function of t

Test whether a log level may be logged.

(maybe anons) indicates that some anonymous arguments are optional

Escape the a CSV field if need be.

logs a message to Some log, returns silently if log is None

maybe_raise name if the exception associated with any name in name has been triggered, then raise it, otherwise do nothing.

(maybe_with_default default anons) indicates an optional anonymous argument with a default value

mem m key returns true if key has at last one value associated to it in m

meminfo_exn queries /proc/meminfo and fills out Meminfo.t.

memoize ~destruct ~expire f memoizes the results of f.

Merges several list trying to keep the order in which the elements appear.

Raises "Failed_command"

When the pretty printer decides to represent a break as a newline it also prints some spaces after it to indent the following line.

new_only hunks drops all Old ranges from hunks and converts all Replace ranges to New ranges.

get the next element of the iterator

next t return the next file from the collection of valid files in t or None if no more files remain

no_arg flags may be passed at most once.

no_arg_register ~key is like no_arg, but registers in the auto-completion environment

an action for a flag that takes no additional argument

normalize path Removes as much "." and ".." from the path as possible.

np_pref no preference for readers or writers.

A value which is always empty

create an iterator that will go over array elements

initialize Cbuffer from array

create an iterator that will read from file using f

Create a lazy value of a function.

create an iterator that will go over list elements

create an iterator that may iterate over one value

of_option o returns a list that is empty if o is None, otherwise it is a singleton list.

of_passwd_file parse a passwd-like file

of_passwd_file_exn parse a passwd-like file

of_passwd_line parse a passwd-like line

of_passwd_line_exn parse a passwd-like line

of_sexp_allow_extra_fields of_sexp sexp uses of_sexp to convert sexp to a value, but will not fail if there any extra fields in a record.

Create a lazy value of a non-lazy value.

ok t returns x if t = Ok x, or raises e if t = Error e.

old_only hunks drops all New ranges from hunks and converts all Replace ranges to Old ranges.

Open a connection with timeouts

Create a socket with timeouts

openlog ?id ?opt ?fac () opens a connection to the system logger (possibly delayed) using prefixed identifier id, options opt, and faculty fac.

???

optional flags may be passed at most once

optional_with_default flags may be passed at most once, and default to a given value

order_of_magnitude_difference a b by how many orders of magnitude do a and b differ? The return value is non-negative.

Print to stderr as well

alias for String.concat

Extensions to Core.Unix.

Extensions to Core.Core_thread

Extensions to Sexplib.Sexp.

Extension to the

normalize path Removes as much "." and ".." from the path as possible.

The idea is that you have a Column.t list and a list of rows, where each row contains the data for each column.

Prints a valid csv file to a given channel (note that line are ended "\r\n")

pad_left ~char s len Returns s padded to the length len by adding characters char to the left of the string.

page_contents ?pager ?tmp_name str will show str in a pager.

parent path The parent of the root directory is the root directory

parse_int s: Like standard int_of_string, but try to convert the first twenty english numbers (eg.

Prompts for a password.

percent_fds_in_use () reports the percentage of fds that are in use.

pgrep f returns all processes for which f is true

physical_ram ()

pkill ~signal f sends the signal to all processes for which f returns true.

Get port from a socket associated with an in_channel

Get port from sockaddr

A more readable but less compact pretty printer than the one bundled by sexplib.

prepend ~specific_cases t matches on specific_cases before moving on to t.

pretty-print a float using no more than five characters, using abberviations k, m, g, t.

print a list in a columnize way (like the output of ls)

get the position in the iterator either None or Some x in 0;1

convert the progress return value to a string: None->"", Some->" 33%"

query hostname returns the difference between the clock on the local host and the clock on the host specified by hostname.

Copy and escapes the content of a field over from one string to another.

Get the escaped length of one quoted field (without the quotes).

r_lock mtx locks mtx for a reader.

r_pref preference kind for readers.

r_unlock mtx unlocks mtx for a reader.

ram_limit_spec command line arguments to set ram limits.

makes a random split & subset of an array; p (the fraction that you want to split) is constrained to be 0, 1.

Calls try_read every 0.01 seconds and returns when a line is available.

fold over the iterator: call f on each element and return the accumulator

remove m key Remove all the values associated the key key in m

remove store key removes the binding for key in store.

Informs the strategy that an element was removed from the store.

replace store ~key ~data associated the data to key; remove any previously existing binding.

report_on_exn exn calls Fd_leak_check.report_open_files iff exn indicates a file descriptor leak (Unix error with code EMFILE or ENFILE).

report_open_files () prints a dump of open file descriptors to stderr in two formats, one using the proc file system, the other by executing /usr/sbin/lsof in a child process.

required flags must be passed exactly once

reopens the file and seeks to the beginning.

rest f: an action for a flag that signals the end of flag processing.

Runs a function in a fork process to ensure a timeout.

Runs a command and discards its output.

run a command against Sys.argv

Toggle to turn on/off checking for descriptor leaks at exit (default: off)

Fold over the lines in the stdout of a process; The `Continue/`Stop argument is there to allow early returning.

Return the full command's output in one string.

Runs a command and returns its output line separated.

Returns the first line of the command's output.

running_byte_code ()

Behaves like Thread.create but exits the program if an exception trickles to the toplevel.

take a sample from the distribution in constant time

scp user host from to copy local file from to to

scroll_lock false disables scroll locking.

(sequence name typ) specifies a sequence of anonymous arguments of type typ.

set t pos set the value in position pos, raises Invalid_argument if the position is out of bounds.

set_diff l1 l2 returns a list of all elements of l1 that are not in l2

Set a timeout for a socket associated with an in_channel

set_inter l1 l2 returns a list without duplicates of all elements of l1 that are in l2

Set minimum log level

Set a timeout for a socket associated with an out_channel

setlogmask ?levs ?from_lev ?to_lev () sets the log mask.

half the size of the buffer

signal sem v allows one thread blocked in Semaphore.wait on semaphore sem to continue.

splice ?assume_fd_is_nonblocking ~fd_in ?off_in ~fd_out ?off_out ~len flags see man-page for details.

split_while xs f splits xs into sublists ys and zs such that ys is the longest prefix on which f is true, and zs is the remaining elements.

Takes a list of `key*`value lists and returns a header * table_body body that is obtained by splitting the lists and re-oddering the terms (so that they all have the same header).

squeeze str reduces all sequences of spaces, newlines, tables, and carriage returns to single spaces.

start starts a thread that watches for blockouts where the OCaml lock isn't released.

A canary thread starts two threads, one in caml and one in C.

get file system statistics

step allows you to transform the way parameters are applied.

step f is a very useful combinator for modifying the behavior of other command line specifications.

string_of_lev lev converts a level lev to a string.

Get string from sockaddr

Returns a smaller sexp by replacing sections with "...".

swap_array buf len copies the contents of buf to a new array of length len and places that new data into the buffer

syslog ?fac ?lev str logs message str using syslog with faculty fac at level lev.

syslog_printf ?fac ?lev fmt same as Syslog.syslog, but allows printf-style specification of the message using fmt.

create an iterator from an iterating function

Seeks to the end of the file and blocks until another line is available -- this new line is not returned.

take_while xs f produces the longest prefix of xs on which f is always true.

Create a standard TCP/IP-socket

tee ?assume_fd_is_nonblocking ~fd_in ~fd_out len flags see man-page for details.