zynk/irssi
2
0
Fork 0
mirror of https://github.com/irssi/irssi.git synced 2026-08-11 12:53:42 +02:00
Code Issues Projects Releases Packages Wiki Activity

Added syntaxes of all commands in comments, they're going to be used to

Browse source 
autogenerate help files.


git-svn-id: http://svn.irssi.org/repos/irssi/trunk@529 dbcabf3a-b0e7-0310-adc4-f8d773084564
This commit is contained in:
Timo Sirainen 2000-07-23 23:19:22 +00:00 • committed by cras
commit c529fe0096
27 changed files with 186 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/fe-common/irc/fe-channels.c
View file

@ -153,6 +153,7 @@ static void cmd_channel_list_joined(void)
}
}
/* SYNTAX: CHANNEL LIST */
static void cmd_channel_list(void)
{
GString *str;
@ -190,6 +191,8 @@ static void cmd_channel(const char *data, IRC_SERVER_REC *server, WI_ITEM_REC *i
command_runsub("channel", data, server, item);
}
/* SYNTAX: CHANNEL ADD [-auto | -noauto] [-bots <masks>] [-botcmd <command>]
<channel> <ircnet> [<password>] */
static void cmd_channel_add(const char *data)
{
GHashTable *optlist;
@ -227,6 +230,7 @@ static void cmd_channel_add(const char *data)
cmd_params_free(free_arg);
}
/* SYNTAX: CHANNEL REMOVE <channel> <ircnet> */
static void cmd_channel_remove(const char *data)
{
SETUP_CHANNEL_REC *rec;

11
src/fe-common/irc/fe-ignore.c
View file

@ -148,14 +148,12 @@ static void cmd_ignore_show(void)
printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, IRCTXT_IGNORE_FOOTER);
}
/* SYNTAX: IGNORE [-regexp | -word] [-pattern <pattern>] [-except] [-replies]
[-channels <channel>] [-time <secs>] <mask> <levels>
IGNORE [-regexp | -word] [-pattern <pattern>] [-except] [-replies]
[-time <secs>] <channels> <levels> */
static void cmd_ignore(const char *data)
{
/* /IGNORE [-regexp | -word] [-pattern <pattern>] [-except]
[-replies] [-channels <channel>] [-time <secs>] <mask> <levels>
OR
/IGNORE [-regexp | -word] [-pattern <pattern>] [-except] [-replies]
[-time <secs>] <channels> <levels> */
GHashTable *optlist;
IGNORE_REC *rec;
char *patternarg, *chanarg, *mask, *levels, *key, *timestr;
@ -247,6 +245,7 @@ static void fe_unignore(IGNORE_REC *rec)
ignore_update_rec(rec);
}
/* SYNTAX: UNIGNORE <id>|<mask> */
static void cmd_unignore(const char *data)
{
IGNORE_REC *rec;

14
src/fe-common/irc/fe-irc-commands.c
View file

@ -38,6 +38,7 @@
#include "windows.h"
#include "window-items.h"
/* SYNTAX: UNQUERY [<nick>] */
static void cmd_unquery(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
QUERY_REC *query;
@ -59,7 +60,8 @@ static void cmd_unquery(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *it
query_destroy(query);
}
static void cmd_query(gchar *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
/* SYNTAX: QUERY <nick> */
static void cmd_query(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
WINDOW_REC *window;
QUERY_REC *query;
@ -178,6 +180,7 @@ static void cmd_msg(gchar *data, IRC_SERVER_REC *server, WI_ITEM_REC *item)
cmd_params_free(free_arg);
}
/* SYNTAX: ME <message> */
static void cmd_me(gchar *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
g_return_if_fail(data != NULL);
@ -195,6 +198,7 @@ static void cmd_me(gchar *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
irc_send_cmdv(server, "PRIVMSG %s :\001ACTION %s\001", item->name, data);
}
/* SYNTAX: ACTION [<target>] <message> */
static void cmd_action(const char *data, IRC_SERVER_REC *server)
{
char *target, *text;
@ -216,7 +220,8 @@ static void cmd_action(const char *data, IRC_SERVER_REC *server)
cmd_params_free(free_arg);
}
static void cmd_notice(gchar *data, IRC_SERVER_REC *server)
/* SYNTAX: NOTICE [<target>] <message> */
static void cmd_notice(const char *data, IRC_SERVER_REC *server)
{
char *target, *msg;
void *free_arg;
@ -307,6 +312,7 @@ static void cmd_wall(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
cmd_params_free(free_arg);
}
/* SYNTAX: BAN [<channel>] [<nicks>] */
static void cmd_ban(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
CHANNEL_REC *cur_channel, *channel;
@ -336,6 +342,7 @@ static void cmd_ban(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
g_string_sprintf(str, "%s e", data);
signal_emit("command mode", 3, str->str, server, cur_channel);
g_string_free(str, TRUE);
signal_stop();
return;
}
}
@ -369,6 +376,7 @@ static void cmd_ban(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
signal_stop();
}
/* SYNTAX: INVITELIST [<channel>] */
static void cmd_invitelist(const char *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
CHANNEL_REC *channel, *cur_channel;
@ -412,6 +420,7 @@ static void cmd_nick(const char *data, IRC_SERVER_REC *server)
signal_stop();
}
/* SYNTAX: VER [<target>] */
static void cmd_ver(gchar *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
{
char *str;
@ -428,6 +437,7 @@ static void cmd_ver(gchar *data, IRC_SERVER_REC *server, WI_IRC_REC *item)
g_free(str);
}
/* SYNTAX: TS */
static void cmd_ts(const char *data)
{
GSList *tmp;

7
src/fe-common/irc/fe-irc-server.c
View file

@ -78,6 +78,9 @@ static void print_reconnects(void)
}
}
/* SYNTAX: SERVER ADD [-auto | -noauto] [-ircnet <ircnet>] [-host <hostname>]
[-cmdspeed <ms>] [-cmdmax <count>] [-port <port>]
<address> [<port> [<password>]] */
static void cmd_server_add(const char *data)
{
GHashTable *optlist;
@ -132,6 +135,7 @@ static void cmd_server_add(const char *data)
cmd_params_free(free_arg);
}
/* SYNTAX: SERVER REMOVE <address> [<port>] */
static void cmd_server_remove(const char *data)
{
SETUP_SERVER_REC *rec;
@ -142,7 +146,7 @@ static void cmd_server_remove(const char *data)
if (!cmd_get_params(data, &free_arg, 2, &addr, &portstr))
return;
if (*addr == '\0') cmd_param_error(CMDERR_NOT_ENOUGH_PARAMS);
port = *portstr == '\0' ? 6667 : atoi(portstr);
port = *portstr == '\0' ? -1 : atoi(portstr);
rec = server_setup_find(addr, port);
if (rec == NULL)
@ -155,6 +159,7 @@ static void cmd_server_remove(const char *data)
cmd_params_free(free_arg);
}
/* SYNTAX: SERVER LIST */
static void cmd_server_list(const char *data)
{
GString *str;

5
src/fe-common/irc/fe-ircnet.c
View file

@ -72,6 +72,10 @@ static void cmd_ircnet_list(void)
printformat(NULL, NULL, MSGLEVEL_CLIENTCRAP, IRCTXT_IRCNET_FOOTER);
}
/* SYNTAX: IRCNET ADD [-kicks <count>] [-msgs <count>] [-modes <count>]
[-whois <count>] [-cmdspeed <ms>] [-cmdmax <count>]
[-nick <nick>] [-user <user>] [-realname <name>]
[-host <host>] [-autosendcmd <cmd>] <name> */
static void cmd_ircnet_add(const char *data)
{
GHashTable *optlist;
@ -135,6 +139,7 @@ static void cmd_ircnet_add(const char *data)
cmd_params_free(free_arg);
}
/* SYNTAX: IRCNET REMOVE <ircnet> */
static void cmd_ircnet_remove(const char *data)
{
IRCNET_REC *rec;

1
src/fe-common/irc/fe-netsplit.c
View file

@ -239,6 +239,7 @@ static void split_print(const char *nick, NETSPLIT_REC *rec)
rec->server->server, rec->server->destserver);
}
/* SYNTAX: NETSPLIT */
static void cmd_netsplit(const char *data, IRC_SERVER_REC *server)
{
if (server == NULL || !server->connected)