lchat

A line oriented chat front end for ii.
git clone git://git.suckless.org/lchat
Log | Files | Refs | README

lchat.1 (2120B)

      1 .Dd May 13, 2018
      2 .Dt LCHAT 1
      3 .Os
      4 .Sh NAME
      5 .Nm lchat
      6 .Nd line chat
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Fl aeh
     10 .Op Fl n Ar lines
     11 .Op Fl p Ar prompt
     12 .Op Fl t Ar title
     13 .Op Fl i Ar in
     14 .Op Fl o Ar out
     15 .Op Fl m Ar mode
     16 .Op directory
     17 .Sh DESCRIPTION
     18 The
     19 .Nm
     20 utility is a command line front end for ii-like chat programs.
     21 It uses
     22 .Xr tail 1
     23 in the background to get output lines from
     24 .Ar out .
     25 .Nm
     26 locates the
     27 .Ar in
     28 and
     29 .Ar out
     30 files inside of the
     31 .Ar directory
     32 path.
     33 .sp 1
     34 The options are as follows:
     35 .Bl -tag -width Ds
     36 .It Fl a
     37 Turn off the bell on external line input.
     38 .It Fl e
     39 Allow to enter empty lines.
     40 .It Fl h
     41 Shows usage text.
     42 .It Fl n Ar lines
     43 Shows
     44 .Ar lines
     45 of chat history at startup.
     46 .It Fl p Ar prompt
     47 Use
     48 .Ar prompt
     49 as prompt for the input line.
     50 .It Fl t Ar title
     51 Use
     52 .Ar title
     53 as title for the terminal window.
     54 In a
     55 .Xr tmux 1
     56 or
     57 .Xr screen 1
     58 environment its change the window name instead of the window title.
     59 .It Fl i Ar in
     60 Use path of
     61 .Ar in
     62 as in-file.
     63 Default is 'in'.
     64 This overrides
     65 .Ar directory .
     66 .It Fl o Ar out
     67 Use path of
     68 .Ar out
     69 as out-file.
     70 Default is 'out'.
     71 This overrides
     72 .Ar directory .
     73 .It Fl m Ar mode
     74 Use the specified
     75 .Ar mode .
     76 Currently, the only valid argument is
     77 .Ar emacs .
     78 See
     79 .Sy MODES
     80 for more information
     81 .It Ar directory
     82 Uses
     83 .Ar directory
     84 to search for in and out file.
     85 Default path is the current working directory.
     86 .El
     87 .Sh FILES
     88 .Bl -tag -width Ds
     89 .It .bellmatch
     90 contains regular expressions that controls bell ring on matching input.
     91 .It .filter
     92 If this file exists and has executable permissions, it is used as a filter
     93 program for the output lines.
     94 This program should read raw lines from stdin and outputs filtered or
     95 transformed lines to stdout.
     96 .It .prompt
     97 contains the prompt string.
     98 .It .title
     99 contains the terminal window title.
    100 .El
    101 .Sh MODES
    102 .Nm
    103 is able to interpret keypresses differently depending on the mode it is
    104 operating in. Each mode defines a set of keybindings and corresponding actions.
    105 The mode cannot be changed while
    106 .Nm
    107 is running.
    108 .Sh SEE ALSO
    109 .Xr ii 1 ,
    110 .Xr tail 1
    111 .Sh AUTHORS
    112 .An -nosplit
    113 The
    114 .Nm
    115 program was written by
    116 .An Jan Klemkow Aq Mt j.klemkow@wemelug.de .