2 * Copyright (C) 1984-2021 Mark Nudelman
4 * You may distribute under the terms of either the GNU General Public
5 * License or the Less License, as specified in the README file.
7 * For more information, see the README file.
12 * lesskey [-o output] [input]
14 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
17 * If no input file is specified, standard input is used.
18 * If no output file is specified, $HOME/.less is used.
20 * The .less file is used to specify (to "less") user-defined
21 * key bindings. Basically any sequence of 1 to MAX_CMDLEN
22 * keystrokes may be bound to an existing less function.
24 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
26 * The input file is an ascii file consisting of a
27 * sequence of lines of the form:
28 * string <whitespace> action [chars] <newline>
30 * "string" is a sequence of command characters which form
31 * the new user-defined command. The command
33 * 1. The actual character itself.
34 * 2. A character preceded by ^ to specify a
35 * control character (e.g. ^X means control-X).
36 * 3. A backslash followed by one to three octal digits
37 * to specify a character by its octal value.
38 * 4. A backslash followed by b, e, n, r or t
39 * to specify \b, ESC, \n, \r or \t, respectively.
40 * 5. Any character (other than those mentioned above) preceded
41 * by a \ to specify the character itself (characters which
42 * must be preceded by \ include ^, \, and whitespace.
43 * "action" is the name of a "less" action, from the table below.
44 * "chars" is an optional sequence of characters which is treated
45 * as keyboard input after the command is executed.
47 * Blank lines and lines which start with # are ignored,
48 * except for the special control lines:
49 * #command Signals the beginning of the command
51 * #line-edit Signals the beginning of the line-editing
53 * #env Signals the beginning of the environment
55 * #stop Stops command parsing in less;
56 * causes all default keys to be disabled.
58 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
60 * The output file is a non-ascii file, consisting of a header,
61 * one or more sections, and a trailer.
62 * Each section begins with a section header, a section length word
63 * and the section data. Normally there are three sections:
64 * CMD_SECTION Definition of command keys.
65 * EDIT_SECTION Definition of editing keys.
66 * END_SECTION A special section header, with no
67 * length word or section data.
69 * Section data consists of zero or more byte sequences of the form:
72 * string <0> <action|A_EXTRA> chars <0>
74 * "string" is the command string.
75 * "<0>" is one null byte.
76 * "<action>" is one byte containing the action code (the A_xxx value).
77 * If action is ORed with A_EXTRA, the action byte is followed
78 * by the null-terminated "chars" string.
80 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
93 struct cmdname cmdnames[] =
95 { "back-bracket", A_B_BRACKET },
96 { "back-line", A_B_LINE },
97 { "back-line-force", A_BF_LINE },
98 { "back-screen", A_B_SCREEN },
99 { "back-scroll", A_B_SCROLL },
100 { "back-search", A_B_SEARCH },
101 { "back-window", A_B_WINDOW },
102 { "clear-mark", A_CLRMARK },
103 { "debug", A_DEBUG },
104 { "digit", A_DIGIT },
105 { "display-flag", A_DISP_OPTION },
106 { "display-option", A_DISP_OPTION },
108 { "end-scroll", A_RRSHIFT },
109 { "examine", A_EXAMINE },
110 { "filter", A_FILTER },
111 { "first-cmd", A_FIRSTCMD },
112 { "firstcmd", A_FIRSTCMD },
113 { "flush-repaint", A_FREPAINT },
114 { "forw-bracket", A_F_BRACKET },
115 { "forw-forever", A_F_FOREVER },
116 { "forw-until-hilite", A_F_UNTIL_HILITE },
117 { "forw-line", A_F_LINE },
118 { "forw-line-force", A_FF_LINE },
119 { "forw-screen", A_F_SCREEN },
120 { "forw-screen-force", A_FF_SCREEN },
121 { "forw-scroll", A_F_SCROLL },
122 { "forw-search", A_F_SEARCH },
123 { "forw-window", A_F_WINDOW },
124 { "goto-end", A_GOEND },
125 { "goto-end-buffered", A_GOEND_BUF },
126 { "goto-line", A_GOLINE },
127 { "goto-mark", A_GOMARK },
129 { "index-file", A_INDEX_FILE },
130 { "invalid", A_UINVALID },
131 { "left-scroll", A_LSHIFT },
132 { "next-file", A_NEXT_FILE },
133 { "next-tag", A_NEXT_TAG },
134 { "noaction", A_NOACTION },
135 { "no-scroll", A_LLSHIFT },
136 { "percent", A_PERCENT },
138 { "prev-file", A_PREV_FILE },
139 { "prev-tag", A_PREV_TAG },
141 { "remove-file", A_REMOVE_FILE },
142 { "repaint", A_REPAINT },
143 { "repaint-flush", A_FREPAINT },
144 { "repeat-search", A_AGAIN_SEARCH },
145 { "repeat-search-all", A_T_AGAIN_SEARCH },
146 { "reverse-search", A_REVERSE_SEARCH },
147 { "reverse-search-all", A_T_REVERSE_SEARCH },
148 { "right-scroll", A_RSHIFT },
149 { "set-mark", A_SETMARK },
150 { "set-mark-bottom", A_SETMARKBOT },
151 { "shell", A_SHELL },
152 { "status", A_STAT },
153 { "toggle-flag", A_OPT_TOGGLE },
154 { "toggle-option", A_OPT_TOGGLE },
155 { "undo-hilite", A_UNDO_SEARCH },
156 { "clear-search", A_CLR_SEARCH },
157 { "version", A_VERSION },
158 { "visual", A_VISUAL },
162 struct cmdname editnames[] =
164 { "back-complete", EC_B_COMPLETE },
165 { "backspace", EC_BACKSPACE },
166 { "delete", EC_DELETE },
169 { "expand", EC_EXPAND },
170 { "forw-complete", EC_F_COMPLETE },
172 { "insert", EC_INSERT },
173 { "invalid", EC_UINVALID },
174 { "kill-line", EC_LINEKILL },
175 { "abort", EC_ABORT },
177 { "literal", EC_LITERAL },
178 { "right", EC_RIGHT },
180 { "word-backspace", EC_W_BACKSPACE },
181 { "word-delete", EC_W_DELETE },
182 { "word-left", EC_W_LEFT },
183 { "word-right", EC_W_RIGHT },
189 struct cmdname *names;
191 char buffer[MAX_USERCMD];
194 struct table cmdtable;
195 struct table edittable;
196 struct table vartable;
197 struct table *currtable = &cmdtable;
199 char fileheader[] = {
205 char filetrailer[] = {
206 C0_END_LESSKEY_MAGIC,
207 C1_END_LESSKEY_MAGIC,
210 char cmdsection[1] = { CMD_SECTION };
211 char editsection[1] = { EDIT_SECTION };
212 char varsection[1] = { VAR_SECTION };
213 char endsection[1] = { END_SECTION };
216 char *outfile = NULL ;
221 extern char version[];
226 fprintf(stderr, "usage: lesskey [-o output] [input]\n");
231 mkpathname(dirname, filename)
237 pathname = calloc(strlen(dirname) + strlen(filename) + 2, sizeof(char));
238 strcpy(pathname, dirname);
239 strcat(pathname, PATHNAME_SEP);
240 strcat(pathname, filename);
245 * Figure out the name of a default file (in the user's HOME directory).
254 if ((p = getenv("HOME")) != NULL && *p != '\0')
255 pathname = mkpathname(p, filename);
257 else if ((p = getenv("INIT")) != NULL && *p != '\0')
258 pathname = mkpathname(p, filename);
262 fprintf(stderr, "cannot find $HOME - using current directory\n");
263 pathname = mkpathname(".", filename);
269 * Parse command line arguments.
272 parse_args(argc, argv)
283 /* Arg does not start with "-"; it's not an option. */
286 /* "-" means standard input. */
288 if (arg[1] == '-' && arg[2] == '\0')
290 /* "--" means end of options. */
298 if (strncmp(arg, "--output", 8) == 0)
302 else if (arg[8] == '=')
308 if (strcmp(arg, "--version") == 0)
315 outfile = &argv[0][2];
317 if (*outfile == '\0')
326 printf("lesskey version %s\n", version);
335 * Open the input file, or use DEF_LESSKEYINFILE if none specified.
340 infile = homefile(DEF_LESSKEYINFILE);
344 * Initialize data structures.
347 init_tables(VOID_PARAM)
349 cmdtable.names = cmdnames;
350 cmdtable.pbuffer = cmdtable.buffer;
352 edittable.names = editnames;
353 edittable.pbuffer = edittable.buffer;
355 vartable.names = NULL;
356 vartable.pbuffer = vartable.buffer;
360 * Parse one character of a string.
371 static char tstr_control_k[] =
372 { SK_SPECIAL_KEY, SK_CONTROL_K, 6, 1, 1, 1, '\0' };
381 case '0': case '1': case '2': case '3':
382 case '4': case '5': case '6': case '7':
384 * Parse an octal number.
389 ch = 8*ch + (*p - '0');
390 while (*++p >= '0' && *p <= '7' && ++i < 3);
392 if (xlate && ch == CONTROL('K'))
393 return tstr_control_k;
419 case 'u': ch = SK_UP_ARROW; break;
420 case 'd': ch = SK_DOWN_ARROW; break;
421 case 'r': ch = SK_RIGHT_ARROW; break;
422 case 'l': ch = SK_LEFT_ARROW; break;
423 case 'U': ch = SK_PAGE_UP; break;
424 case 'D': ch = SK_PAGE_DOWN; break;
425 case 'h': ch = SK_HOME; break;
426 case 'e': ch = SK_END; break;
427 case 'x': ch = SK_DELETE; break;
429 error("illegal char after \\k", NULL_PARG);
434 buf[0] = SK_SPECIAL_KEY;
446 * Backslash followed by any other char
447 * just means that char.
452 if (xlate && buf[0] == CONTROL('K'))
453 return tstr_control_k;
458 * Caret means CONTROL.
461 buf[0] = CONTROL(p[1]);
463 if (xlate && buf[0] == CONTROL('K'))
464 return tstr_control_k;
470 if (xlate && buf[0] == CONTROL('K'))
471 return tstr_control_k;
476 * Skip leading spaces in a string.
482 while (*s == ' ' || *s == '\t')
488 * Skip non-space characters in a string.
494 while (*s != '\0' && *s != ' ' && *s != '\t')
500 * Clean up an input line:
501 * strip off the trailing newline & any trailing # comment.
510 for (i = 0; s[i] != '\n' && s[i] != '\r' && s[i] != '\0'; i++)
511 if (s[i] == '#' && (i == 0 || s[i-1] != '\\'))
518 * Add a byte to the output command table.
524 if (currtable->pbuffer >= currtable->buffer + MAX_USERCMD)
526 error("too many commands", NULL_PARG);
529 *(currtable->pbuffer)++ = c;
533 * Add a string to the output command table.
539 for ( ; *s != '\0'; s++)
544 * See if we have a special "control" line.
550 #define PREFIX(str,pat) (strncmp(str,pat,strlen(pat)) == 0)
552 if (PREFIX(s, "#line-edit"))
554 currtable = &edittable;
557 if (PREFIX(s, "#command"))
559 currtable = &cmdtable;
562 if (PREFIX(s, "#env"))
564 currtable = &vartable;
567 if (PREFIX(s, "#stop"))
570 add_cmd_char(A_END_LIST);
580 fputbytes(fd, buf, len)
587 fwrite(buf, sizeof(char), 1, fd);
593 * Output an integer, in special KRADIX form.
602 if (val >= KRADIX*KRADIX)
604 fprintf(stderr, "error: integer too big (%d > %d)\n",
609 fwrite(&c, sizeof(char), 1, fd);
611 fwrite(&c, sizeof(char), 1, fd);
615 * Find an action, given the name of the action.
623 for (i = 0; currtable->names[i].cn_name != NULL; i++)
624 if (strcmp(currtable->names[i].cn_name, actname) == 0)
625 return (currtable->names[i].cn_action);
626 error("unknown action", NULL_PARG);
635 fprintf(stderr, "line %d: %s\n", linenum, s);
652 * Parse the command string and store it in the current table.
658 cmdlen += (int) strlen(s);
659 if (cmdlen > MAX_CMDLEN)
660 error("command too long", NULL_PARG);
663 } while (*p != ' ' && *p != '\t' && *p != '\0');
665 * Terminate the command string with a null byte.
670 * Skip white space between the command string
671 * and the action name.
672 * Terminate the action name with a null byte.
677 error("missing action", NULL_PARG);
686 * Parse the action name and store it in the current table.
688 action = findaction(actname);
691 * See if an extra string follows the action name.
697 add_cmd_char(action);
701 * OR the special value A_EXTRA into the action byte.
702 * Put the extra string after the action byte.
704 add_cmd_char(action | A_EXTRA);
706 add_cmd_str(tstr(&p, 0));
721 } while (*p != ' ' && *p != '\t' && *p != '=' && *p != '\0');
723 * Terminate the variable name with a null byte.
730 error("missing =", NULL_PARG);
734 add_cmd_char(EV_OK|A_EXTRA);
746 * Parse a line from the lesskey file.
755 * See if it is a control line.
757 if (control_line(line))
760 * Skip leading white space.
761 * Replace the final newline with a null byte.
762 * Ignore blank lines and comments.
764 p = clean_line(line);
768 if (currtable == &vartable)
784 if (getenv("HOME") == NULL)
787 * If there is no HOME environment variable,
788 * try the concatenation of HOMEDRIVE + HOMEPATH.
790 char *drive = getenv("HOMEDRIVE");
791 char *path = getenv("HOMEPATH");
792 if (drive != NULL && path != NULL)
794 char *env = (char *) calloc(strlen(drive) +
795 strlen(path) + 6, sizeof(char));
796 strcpy(env, "HOME=");
805 * Process command line arguments.
807 parse_args(argc, argv);
811 * Open the input file.
813 if (strcmp(infile, "-") == 0)
815 else if ((desc = fopen(infile, "r")) == NULL)
820 fprintf(stderr, "Cannot open %s\n", infile);
826 * Read and parse the input file, one line at a time.
830 while (fgets(line, sizeof(line), desc) != NULL)
837 * Write the output file.
838 * If no output file was specified, use "$HOME/.less"
842 fprintf(stderr, "%d errors; no output produced\n", errors);
847 outfile = getenv("LESSKEY");
849 outfile = homefile(LESSKEYFILE);
850 if ((out = fopen(outfile, "wb")) == NULL)
855 fprintf(stderr, "Cannot open %s\n", outfile);
861 fputbytes(out, fileheader, sizeof(fileheader));
863 /* Command key section */
864 fputbytes(out, cmdsection, sizeof(cmdsection));
865 fputint(out, cmdtable.pbuffer - cmdtable.buffer);
866 fputbytes(out, (char *)cmdtable.buffer, cmdtable.pbuffer-cmdtable.buffer);
867 /* Edit key section */
868 fputbytes(out, editsection, sizeof(editsection));
869 fputint(out, edittable.pbuffer - edittable.buffer);
870 fputbytes(out, (char *)edittable.buffer, edittable.pbuffer-edittable.buffer);
872 /* Environment variable section */
873 fputbytes(out, varsection, sizeof(varsection));
874 fputint(out, vartable.pbuffer - vartable.buffer);
875 fputbytes(out, (char *)vartable.buffer, vartable.pbuffer-vartable.buffer);
878 fputbytes(out, endsection, sizeof(endsection));
879 fputbytes(out, filetrailer, sizeof(filetrailer));