1 /****************************************************************************
2 * Copyright 2020 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 ****************************************************************************/
38 * The initial adaptation from 4.4BSD Lite sources in September 1995 used 686
39 * lines from that version, and made changes/additions for 150 lines. There
40 * was no reformatting, so with/without ignoring whitespace, the amount of
43 * Comparing with current (2009) source, excluding this comment:
44 * a) 209 lines match identically to the 4.4BSD Lite sources, with 771 lines
46 * a) Ignoring whitespace, the current version still uses 516 lines from the
47 * 4.4BSD Lite sources, with 402 lines changed/added.
49 * Raymond's original comment on this follows...
53 * tset.c - terminal initialization utility
55 * This code was mostly swiped from 4.4BSD tset, with some obsolescent
56 * cruft removed and substantial portions rewritten. A Regents of the
57 * University of California copyright applies to some portions of the
58 * code, and is reproduced below:
61 * Copyright (c) 1980, 1991, 1993
62 * The Regents of the University of California. All rights reserved.
64 * Redistribution and use in source and binary forms, with or without
65 * modification, are permitted provided that the following conditions
67 * 1. Redistributions of source code must retain the above copyright
68 * notice, this list of conditions and the following disclaimer.
69 * 2. Redistributions in binary form must reproduce the above copyright
70 * notice, this list of conditions and the following disclaimer in the
71 * documentation and/or other materials provided with the distribution.
72 * 3. Neither the name of the University nor the names of its contributors
73 * may be used to endorse or promote products derived from this software
74 * without specific prior written permission.
76 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
77 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
78 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
79 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
80 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
81 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
82 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
83 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
84 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
85 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
89 #include <reset_cmd.h>
91 #include <transform.h>
92 #include <tty_settings.h>
94 #if HAVE_GETTTYNAM && HAVE_TTYENT_H
98 char *ttyname(int fd);
101 MODULE_ID("$Id: tset.c,v 1.125 2020/09/05 22:54:47 tom Exp $")
104 extern char **environ;
107 const char *_nc_progname = "tset";
109 #define LOWERCASE(c) ((isalpha(UChar(c)) && isupper(UChar(c))) ? tolower(UChar(c)) : (c))
111 static void exit_error(void) GCC_NORETURN;
114 CaselessCmp(const char *a, const char *b)
115 { /* strcasecmp isn't portable */
117 int cmp = LOWERCASE(*a) - LOWERCASE(*b);
122 return LOWERCASE(*a) - LOWERCASE(*b);
128 restore_tty_settings();
129 (void) fprintf(stderr, "\n");
131 ExitProgram(EXIT_FAILURE);
136 err(const char *fmt, ...)
140 (void) fprintf(stderr, "%s: ", _nc_progname);
141 (void) vfprintf(stderr, fmt, ap);
148 failed(const char *msg)
151 size_t len = strlen(_nc_progname) + 2;
153 if ((int) len < (int) sizeof(temp) - 12) {
154 _nc_STRCPY(temp, _nc_progname, sizeof(temp));
155 _nc_STRCAT(temp, ": ", sizeof(temp));
157 _nc_STRCPY(temp, "tset: ", sizeof(temp));
159 _nc_STRNCAT(temp, msg, sizeof(temp), sizeof(temp) - strlen(temp) - 2);
165 /* Prompt the user for a terminal type. */
167 askuser(const char *dflt)
169 static char answer[256];
172 /* We can get recalled; if so, don't continue uselessly. */
174 if (feof(stdin) || ferror(stdin)) {
175 (void) fprintf(stderr, "\n");
181 (void) fprintf(stderr, "Terminal type? [%s] ", dflt);
183 (void) fprintf(stderr, "Terminal type? ");
184 (void) fflush(stderr);
186 if (fgets(answer, sizeof(answer), stdin) == 0) {
194 if ((p = strchr(answer, '\n')) != 0)
203 /**************************************************************************
205 * Mapping logic begins here
207 **************************************************************************/
209 /* Baud rate conditionals for mapping. */
218 struct map *next; /* Linked list of maps. */
219 const char *porttype; /* Port type, or "" for any. */
220 const char *type; /* Terminal type to select. */
221 int conditional; /* Baud rate conditionals bitmask. */
222 int speed; /* Baud rate to compare against. */
225 static MAP *cur, *maplist;
227 #define DATA(name,value) { { name }, value }
229 typedef struct speeds {
230 const char string[8];
234 #if defined(EXP_WIN32_DRIVER)
235 static const SPEEDS speeds[] =
240 static const SPEEDS speeds[] =
257 /* sgttyb may define up to this point */
259 DATA("19200", B19200),
262 DATA("38400", B38400),
265 DATA("19200", B19200),
268 DATA("38400", B38400),
271 DATA("19200", B19200),
278 DATA("38400", B38400),
285 DATA("57600", B57600),
288 DATA("76800", B57600),
291 DATA("115200", B115200),
294 DATA("153600", B153600),
297 DATA("230400", B230400),
300 DATA("307200", B307200),
303 DATA("460800", B460800),
306 DATA("500000", B500000),
309 DATA("576000", B576000),
312 DATA("921600", B921600),
315 DATA("1000000", B1000000),
318 DATA("1152000", B1152000),
321 DATA("1500000", B1500000),
324 DATA("2000000", B2000000),
327 DATA("2500000", B2500000),
330 DATA("3000000", B3000000),
333 DATA("3500000", B3500000),
336 DATA("4000000", B4000000),
343 tbaudrate(char *rate)
345 const SPEEDS *sp = 0;
348 /* The baudrate number can be preceded by a 'B', which is ignored. */
352 for (n = 0; n < SIZEOF(speeds); ++n) {
353 if (n > 0 && (speeds[n].speed <= speeds[n - 1].speed)) {
354 /* if the speeds are not increasing, likely a numeric overflow */
357 if (!CaselessCmp(rate, speeds[n].string)) {
363 err("unknown baud rate %s", rate);
369 * [port-type][test baudrate]:terminal-type
370 * The baud rate tests are: >, <, @, =, !
373 add_mapping(const char *port, char *arg)
381 mapp = typeMalloc(MAP, 1);
382 if (copy == 0 || mapp == 0)
390 cur = maplist = mapp;
396 mapp->porttype = arg;
397 mapp->conditional = 0;
399 arg = strpbrk(arg, "><@=!:");
401 if (arg == 0) { /* [?]term */
402 mapp->type = mapp->porttype;
407 if (arg == mapp->porttype) /* [><@=! baud]:term */
408 termp = mapp->porttype = 0;
412 for (;; ++arg) { /* Optional conditionals. */
415 if (mapp->conditional & GT)
417 mapp->conditional |= LT;
420 if (mapp->conditional & LT)
422 mapp->conditional |= GT;
425 case '=': /* Not documented. */
426 mapp->conditional |= EQ;
429 mapp->conditional |= NOT;
438 if (mapp->conditional)
441 } else { /* Optional baudrate. */
442 arg = strchr(p = arg, ':');
446 mapp->speed = tbaudrate(p);
451 /* Terminate porttype, if specified. */
455 /* If a NOT conditional, reverse the test. */
456 if (mapp->conditional & NOT)
457 mapp->conditional = ~mapp->conditional & (EQ | GT | LT);
459 /* If user specified a port with an option flag, set it. */
462 if (mapp->porttype) {
464 err("illegal -m option format: %s", copy);
466 mapp->porttype = port;
470 (void) printf("port: %s\n", mapp->porttype ? mapp->porttype : "ANY");
471 (void) printf("type: %s\n", mapp->type);
472 (void) printf("conditional: ");
474 if (mapp->conditional & GT) {
478 if (mapp->conditional & EQ) {
479 (void) printf("%sEQ", p);
482 if (mapp->conditional & LT)
483 (void) printf("%sLT", p);
484 (void) printf("\nspeed: %d\n", mapp->speed);
489 * Return the type of terminal to use for a port of type 'type', as specified
490 * by the first applicable mapping in 'map'. If no mappings apply, return
494 mapped(const char *type)
499 for (mapp = maplist; mapp; mapp = mapp->next)
500 if (mapp->porttype == 0 || !strcmp(mapp->porttype, type)) {
501 switch (mapp->conditional) {
502 case 0: /* No test specified. */
506 match = ((int) ospeed == mapp->speed);
509 match = ((int) ospeed >= mapp->speed);
512 match = ((int) ospeed > mapp->speed);
515 match = ((int) ospeed <= mapp->speed);
518 match = ((int) ospeed < mapp->speed);
526 /* No match found; return given type. */
530 /**************************************************************************
534 **************************************************************************/
537 * Figure out what kind of terminal we're dealing with, and then read in
541 get_termcap_entry(int fd, char *userarg)
560 /* Try the environment. */
561 if ((ttype = getenv("TERM")) != 0)
564 if ((ttypath = ttyname(fd)) != 0) {
565 p = _nc_basename(ttypath);
568 * We have the 4.3BSD library call getttynam(3); that means
569 * there's an /etc/ttys to look up device-to-type mappings in.
570 * Try ttyname(3); check for dialup or other mapping.
572 if ((t = getttynam(p))) {
577 if ((fp = fopen("/etc/ttytype", "r")) != 0
578 || (fp = fopen("/etc/ttys", "r")) != 0) {
582 while (fgets(buffer, sizeof(buffer) - 1, fp) != 0) {
583 for (s = buffer, t = d = 0; *s; s++) {
584 if (isspace(UChar(*s)))
588 else if (d == 0 && s != buffer && s[-1] == '\0')
591 if (t != 0 && d != 0 && !strcmp(d, p)) {
599 #endif /* HAVE_GETTTYNAM */
602 /* If still undefined, use "unknown". */
605 map:ttype = mapped(ttype);
608 * If not a path, remove TERMCAP from the environment so we get a
609 * real entry from /etc/termcap. This prevents us from being fooled
610 * by out of date stuff in the environment.
613 if ((p = getenv("TERMCAP")) != 0 && !_nc_is_abs_path(p)) {
614 /* 'unsetenv("TERMCAP")' is not portable.
615 * The 'environ' array is better.
618 for (n = 0; environ[n] != 0; n++) {
619 if (!strncmp("TERMCAP=", environ[n], (size_t) 8)) {
620 while ((environ[n] = environ[n + 1]) != 0) {
629 * ttype now contains a pointer to the type of the terminal.
630 * If the first character is '?', ask the user.
632 if (ttype[0] == '?') {
633 if (ttype[1] != '\0')
634 ttype = askuser(ttype + 1);
638 /* Find the terminfo entry. If it doesn't exist, ask the user. */
639 while (setupterm((NCURSES_CONST char *) ttype, fd, &errret)
642 (void) fprintf(stderr, "%s: unknown terminal type %s\n",
643 _nc_progname, ttype);
646 (void) fprintf(stderr,
647 "%s: can't initialize terminal type %s (error %d)\n",
648 _nc_progname, ttype, errret);
651 ttype = askuser(ttype);
654 tgetflag("am"); /* force lib_termcap.o to be linked for 'ospeed' */
659 /**************************************************************************
663 **************************************************************************/
666 * Convert the obsolete argument forms into something that getopt can handle.
667 * This means that -e, -i and -k get default arguments supplied for them.
670 obsolete(char **argv)
672 for (; *argv; ++argv) {
673 char *parm = argv[0];
675 if (parm[0] == '-' && parm[1] == '\0') {
676 argv[0] = strdup("-q");
681 || (argv[1] && argv[1][0] != '-')
682 || (parm[1] != 'e' && parm[1] != 'i' && parm[1] != 'k')
683 || (parm[2] != '\0'))
685 switch (argv[0][1]) {
687 argv[0] = strdup("-e^H");
690 argv[0] = strdup("-i^C");
693 argv[0] = strdup("-k^U");
700 print_shell_commands(const char *ttype)
707 * Figure out what shell we're using. A hack, we look for an
708 * environmental variable SHELL ending in "csh".
710 if ((var = getenv("SHELL")) != 0
711 && ((len = (int) strlen(leaf = _nc_basename(var))) >= 3)
712 && !strcmp(leaf + len - 3, "csh"))
713 p = "set noglob;\nsetenv TERM %s;\nunset noglob;\n";
716 (void) printf(p, ttype);
722 #define SKIP(s) /* nothing */
723 #define KEEP(s) s "\n"
724 static const char msg[] =
728 SKIP(" -a arpanet (obsolete)")
729 KEEP(" -c set control characters")
730 SKIP(" -d dialup (obsolete)")
731 KEEP(" -e ch erase character")
732 KEEP(" -I no initialization strings")
733 KEEP(" -i ch interrupt character")
734 KEEP(" -k ch kill character")
735 KEEP(" -m mapping map identifier to type")
736 SKIP(" -p plugboard (obsolete)")
737 KEEP(" -Q do not output control key settings")
738 KEEP(" -q display term only, do no changes")
739 KEEP(" -r display term on stderr")
740 SKIP(" -S (obsolete)")
741 KEEP(" -s output TERM set command")
742 KEEP(" -V print curses-version")
743 KEEP(" -w set window-size")
745 KEEP("If neither -c/-w are given, both are assumed.")
749 (void) fprintf(stderr, "Usage: %s [options] [terminal]\n", _nc_progname);
751 ExitProgram(EXIT_FAILURE);
758 return (char) ((optarg[0] == '^' && optarg[1] != '\0')
759 ? ((optarg[1] == '?') ? '\177' : CTRL(optarg[1]))
764 main(int argc, char **argv)
766 int ch, noinit, noset, quiet, Sflag, sflag, showterm;
768 int terasechar = -1; /* new erase character */
769 int intrchar = -1; /* new interrupt character */
770 int tkillchar = -1; /* new kill character */
772 bool opt_c = FALSE; /* set control-chars */
773 bool opt_w = FALSE; /* set window-size */
776 my_fd = STDERR_FILENO;
778 noinit = noset = quiet = Sflag = sflag = showterm = 0;
779 while ((ch = getopt(argc, argv, "a:cd:e:Ii:k:m:p:qQrSsVw")) != -1) {
781 case 'c': /* set control-chars */
784 case 'a': /* OBSOLETE: map identifier to type */
785 add_mapping("arpanet", optarg);
787 case 'd': /* OBSOLETE: map identifier to type */
788 add_mapping("dialup", optarg);
790 case 'e': /* erase character */
791 terasechar = arg_to_char();
793 case 'I': /* no initialization strings */
796 case 'i': /* interrupt character */
797 intrchar = arg_to_char();
799 case 'k': /* kill character */
800 tkillchar = arg_to_char();
802 case 'm': /* map identifier to type */
803 add_mapping(0, optarg);
805 case 'p': /* OBSOLETE: map identifier to type */
806 add_mapping("plugboard", optarg);
808 case 'Q': /* don't output control key settings */
811 case 'q': /* display term only */
814 case 'r': /* display term on stderr */
817 case 'S': /* OBSOLETE: output TERM & TERMCAP */
820 case 's': /* output TERM set command */
823 case 'V': /* print curses-version */
824 puts(curses_version());
825 ExitProgram(EXIT_SUCCESS);
826 case 'w': /* set window-size */
835 _nc_progname = _nc_rootname(*argv);
842 if (!opt_c && !opt_w)
843 opt_c = opt_w = TRUE;
845 my_fd = save_tty_settings(&mode, TRUE);
848 ospeed = (NCURSES_OSPEED) cfgetospeed(&mode);
849 #elif defined(EXP_WIN32_DRIVER)
852 ospeed = (NCURSES_OSPEED) mode.sg_ospeed;
855 if (same_program(_nc_progname, PROG_RESET)) {
856 reset_start(stderr, TRUE, FALSE);
857 reset_tty_settings(my_fd, &mode);
859 reset_start(stderr, FALSE, TRUE);
862 ttype = get_termcap_entry(my_fd, *argv);
867 set_window_size(my_fd, &lines, &columns);
871 set_control_chars(&mode, terasechar, intrchar, tkillchar);
872 set_conversions(&mode);
875 if (send_init_strings(my_fd, &oldmode)) {
876 (void) putc('\r', stderr);
877 (void) fflush(stderr);
878 (void) napms(1000); /* Settle the terminal. */
882 update_tty_settings(&oldmode, &mode);
887 (void) printf("%s\n", ttype);
890 (void) fprintf(stderr, "Terminal type is %s.\n", ttype);
892 * If erase, kill and interrupt characters could have been
893 * modified and not -Q, display the changes.
896 print_tty_chars(&oldmode, &mode);
901 err("The -S option is not supported under terminfo.");
904 print_shell_commands(ttype);
907 ExitProgram(EXIT_SUCCESS);