Mercurial > irccd

comparison doc/man/irccdctl.conf.5.in @ 372:6a7850696b86

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccdctl: rework a bit how aliases are defined to allow better arguments parsing
author David Demelier <markand@malikania.fr>
date Thu, 08 Dec 2016 13:15:37 +0100
parents 2a6ac6daceee
children c6fbb6e0e06d
comparison
equal deleted inserted replaced
371:c6fb00344c19 372:6a7850696b86
83 .Pp 83 .Pp
84 .Bl -tag -width PARAMETERXXX -compact -offset indent 84 .Bl -tag -width PARAMETERXXX -compact -offset indent
85 .It path 85 .It path
86 (string) the file path to the socket. 86 (string) the file path to the socket.
87 .El 87 .El
88 .\" ALIAS
89 .Ss alias
90 The alias section can be used to define custom user commands.
91 .Pp
92 To define an alias, just add a new section named
93 .Nm alias.name
94 where name is your desired alias name.
95 .Pp
96 Then, add any option you like to execute commands you want. The option name is
97 ignored and serves as auto-documentation only.
98 .Pp
99 Example:
100 .Bd -literal
101 [alias.present]
102 say-hello = ( "server-message", "localhost", "#staff", "hello world!" )
103 warning = ( "server-me", "localhost", "#staff", "is a bot")
104 .Ed
105 .Pp
106 .Nm Placeholders
107 .Pp
108 Sometimes, you want to pass parameters to your alias. The placeholder syntax
109 allows you to define where your command line arguments will be replaced before
110 being sent to irccd.
111 .Pp
112 The syntax uses `%n` where **n** is an integer starting from 0.
113 .Pp
114 Example:
115 .Bd -literal
116 [alias.present]
117 say-hello = ( "server-message", "%0", "%1", "hello world!" )
118 warning = ( "server-me", "%0", "%1", "is a bot")
119 .Ed
88 .\" FILES 120 .\" FILES
89 .Sh FILES 121 .Sh FILES
90 The default config file is located at 122 The default config file is located at
91 .Em @CMAKE_INSTALL_PREFIX@/@WITH_CONFDIR@/irccdctl.conf 123 .Em @CMAKE_INSTALL_PREFIX@/@WITH_CONFDIR@/irccdctl.conf
92 .Pp 124 .Pp