hirc

[archived] IRC client
git clone https://hhvn.uk/hirc
git clone git://hhvn.uk/hirc
Log | Files | Refs

hirc.conf.5 (1944B)

      1 .\" vim: set syntax=nroff :
      2 .Dd COMMIT
      3 .Dt hirc.conf 5
      4 .Os
      5 .Sh NAME
      6 .Nm hirc.conf
      7 .Nd configuration format for
      8 .Xr hirc 1
      9 .Sh DESCRIPTION
     10 A
     11 .Nm
     12 file is made up of lines. Each line can be either a command or a comment.
     13 A command is a line that begins with a forward-slash
     14 .Pq Sq / :
     15 these are executed by hirc as though they were typed by the user.
     16 Any other line is a comment and results in no action.
     17 
     18 The commands that can be used in
     19 .Nm
     20 are described in
     21 .Xr hirc 1 .
     22 .Sh GENERATION
     23 See the
     24 .Ic dump
     25 command in
     26 .Xr hirc 1
     27 .Sh TIPS
     28 This section is entirely informative in intent and does not constitute a recommendation.
     29 .Ss Comments
     30 Comments can usually be written directly at the beginning of a line without worrying about inserting any special characters.
     31 In order to prevent a command from running, a space
     32 .Pq Sq \ 
     33 can be placed at the start of the line.
     34 It may be hard to tell wether a line is a comment or not with this,
     35 so using a hash
     36 .Pq Sq #
     37 instead may be preferred.
     38 Syntax highlighting can also be used,
     39 making it very easy to tell if a line is a comment or not, visually:
     40 see the
     41 .Sx FILES
     42 section.
     43 .Ss Running Multiple Commands
     44 With commands that take other commands as arguments (e,g:
     45 .Ic /alias
     46 and
     47 .Ic /bind )
     48 there is no syntax for passing multiple commands.
     49 
     50 However,
     51 .Nm
     52 can be used to create macros, that can then be called using the
     53 .Ic /source
     54 command.
     55 
     56 An example macro named
     57 .Pa ~/.config/hirc/macros/clutter :
     58 .Dl /toggle buflist.hidden
     59 .Dl /toggle nicklist.hidden
     60 
     61 Which could be configured to run on a keybind with:
     62 .Dl /bind ^[b /source ~/.config/hirc/macros/clutter
     63 .Sh FILES
     64 Files included with the hirc source repository:
     65 .Bl -tag -width vim/ftdetect/hirc.vim -compact
     66 .It Pa doc/example.conf
     67 Example configuration.
     68 .It Pa vim/syntax/hirc.vim
     69 Syntax file for
     70 .Xr vim 1 .
     71 .It Pa vim/ftdetect/hirc.vim
     72 Detection of hirc config files for
     73 .Xr vim 1 .
     74 .Sh SEE ALSO
     75 .Xr hirc 1
     76 .Sh AUTHOR
     77 .An hhvn Aq Mt dev@hhvn.uk