summaryrefslogtreecommitdiff
path: root/usr/src/tools/cscope-fast/help.c
blob: 65dd8d6961c063901ab87846db81d7b494129d22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*	Copyright (c) 1988 AT&T	*/
/*	  All Rights Reserved  	*/


/*
 * Copyright (c) 1999 by Sun Microsystems, Inc.
 * All rights reserved.
 */

/*
 *	cscope - interactive C symbol cross-reference
 *
 *	display help
 */

#include "global.h"
#include <curses.h>	/* LINES */

#define	MAXHELP	50	/* maximum number of help strings */

void
help(void)
{
	char	**ep, *s, **tp, *text[MAXHELP];
	int	line;

	tp = text;
	if (changing == NO) {
		if (mouse) {
			*tp++ = "Point with the mouse and click button 1 to "
			    "move to the desired input field,\n";
			*tp++ = "type the pattern to search for, and then "
			    "press the RETURN key.  For the first 5\n";
			*tp++ = "and last 2 input fields, the pattern can be "
			    "a regcmp(3C) regular expression.\n";
			*tp++ = "If the search is successful, you can edit "
			    "the file containing a displayed line\n";
			*tp++ = "by pointing with the mouse and clicking "
			    "button 1.\n";
			*tp++ = "\nYou can either use the button 2 menu or "
			    "these command characters:\n\n";
		} else {
			*tp++ = "Press the TAB key repeatedly to move to the "
			    "desired input field, type the\n";
			*tp++ = "pattern to search for, and then press the "
			    "RETURN key.  For the first 4 and\n";
			*tp++ = "last 2 input fields, the pattern can be a "
			    "regcmp(3C) regular expression.\n";
			*tp++ = "If the search is successful, you can use "
			    "these command characters:\n\n";
			*tp++ = "1-9\tEdit the file containing the displayed "
			    "line.\n";
		}
		*tp++ = "space\tDisplay next lines.\n";
		*tp++ = "+\tDisplay next lines.\n";
		*tp++ = "-\tDisplay previous lines.\n";
		*tp++ = "^E\tEdit all lines.\n";
		*tp++ = ">\tWrite all lines to a file.\n";
		*tp++ = ">>\tAppend all lines to a file.\n";
		*tp++ = "<\tRead lines from a file.\n";
		*tp++ = "^\tFilter all lines through a shell command.\n";
		*tp++ = "|\tPipe all lines to a shell command.\n";
		*tp++ = "\nAt any time you can use these command "
		    "characters:\n\n";
		if (!mouse) {
			*tp++ = "^P\tMove to the previous input field.\n";
		}
		*tp++ = "^A\tSearch again with the last pattern typed.\n";
		*tp++ = "^B\tRecall previous input field and search pattern.\n";
		*tp++ = "^F\tRecall next input field and search pattern.\n";
		*tp++ = "^C\tToggle ignore/use letter case when searching.\n";
		*tp++ = "^R\tRebuild the symbol database.\n";
		*tp++ = "!\tStart an interactive shell (type ^D to return "
		    "to cscope).\n";
		*tp++ = "^L\tRedraw the screen.\n";
		*tp++ = "?\tDisplay this list of commands.\n";
		*tp++ = "^D\tExit cscope.\n";
		*tp++ = "\nNote: If the first character of the pattern you "
		    "want to search for matches\n";
		*tp++ = "a command, type a \\ character first.\n";
	} else {
		if (mouse) {
			*tp++ = "Point with the mouse and click button 1 "
			    "to mark or unmark the line to be\n";
			*tp++ = "changed.  You can also use the button 2 "
			    "menu or these command characters:\n\n";
		} else {
			*tp++ = "When changing text, you can use these "
			    "command characters:\n\n";
			*tp++ = "1-9\tMark or unmark the line to be changed.\n";
		}
		*tp++ = "*\tMark or unmark all displayed lines to be "
		    "changed.\n";
		*tp++ = "space\tDisplay next lines.\n";
		*tp++ = "+\tDisplay next lines.\n";
		*tp++ = "-\tDisplay previous lines.\n";
		*tp++ = "a\tMark or unmark all lines to be changed.\n";
		*tp++ = "^D\tChange the marked lines and exit.\n";
		*tp++ = "RETURN\tExit without changing the marked lines.\n";
		*tp++ = "!\tStart an interactive shell (type ^D to return "
		    "to cscope).\n";
		*tp++ = "^L\tRedraw the screen.\n";
		*tp++ = "?\tDisplay this list of commands.\n";
	}
	/* print help, a screen at a time */
	ep = tp;
	line = 0;
	for (tp = text; tp < ep; ) {
		if (line < LINES - 1) {
			for (s = *tp; *s != '\0'; ++s) {
				if (*s == '\n') {
					++line;
				}
			}
			(void) addstr(*tp++);
		} else {
			(void) addstr("\n");
			askforchar();
			(void) clear();
			line = 0;
		}
	}
	if (line) {
		(void) addstr("\n");
		askforchar();
	}
}