Angband
Functions
ui-help.c File Reference

In-game help. More...

#include "angband.h"
#include "buildid.h"
#include "init.h"
#include "ui-input.h"
#include "ui-output.h"
#include "ui-term.h"

Functions

static void string_lower (char *buf)
 Make a string lower case. More...
 
bool show_file (const char *name, const char *what, int line, int mode)
 Recursive file perusal. More...
 
void do_cmd_help (void)
 Peruse the On-Line-Help. More...
 

Detailed Description

In-game help.

Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke

This work is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation, version 2, or

b) the "Angband licence": This software may be copied and distributed for educational, research, and not for profit purposes provided that this copyright and statement are included in all such copies. Other copyrights may also apply.

Function Documentation

void do_cmd_help ( void  )

Peruse the On-Line-Help.

References NULL, screen_load(), screen_save(), show_file(), and void().

Referenced by menu_question(), and roller_command().

bool show_file ( const char *  name,
const char *  what,
int  line,
int  mode 
)

Recursive file perusal.

Return false on "?", otherwise true.

This function could be made much more efficient with the use of "seek" functionality, especially when moving backwards through a file, or forwards through a file by less than a page at a time. XXX XXX XXX

References A2I, ANGBAND_DIR_HELP, ANGBAND_DIR_INFO, ARROW_DOWN, ARROW_UP, askfor_aux(), bell(), buf, buildid, keypress::code, COLOUR_WHITE, COLOUR_YELLOW, contains_only_spaces(), ESCAPE, EVENT_MESSAGE_FLUSH, event_signal(), file_close(), file_getl(), file_open(), format(), FTYPE_TEXT, i, inkey(), KC_END, KC_ENTER, KC_HOME, KC_PGDOWN, KC_PGUP, MODE_READ, msg, my_strcpy(), NULL, path, path_build(), prefix(), prt(), show_file(), size, streq, strescape(), string_lower(), strnfmt(), strskip(), tag, Term_clear(), Term_get_size(), Term_putstr(), and void().

Referenced by do_cmd_help(), do_cmd_wiz_help(), option_toggle_handle(), and show_file().

static void string_lower ( char *  buf)
static

Make a string lower case.

Referenced by show_file().