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.121 2020/02/02 23:34:34 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[7];
234 static const SPEEDS speeds[] =
251 /* sgttyb may define up to this point */
253 DATA("19200", B19200),
256 DATA("38400", B38400),
259 DATA("19200", B19200),
262 DATA("38400", B38400),
265 DATA("19200", B19200),
272 DATA("38400", B38400),
279 DATA("57600", B57600),
282 DATA("76800", B57600),
285 DATA("115200", B115200),
288 DATA("153600", B153600),
291 DATA("230400", B230400),
294 DATA("307200", B307200),
297 DATA("460800", B460800),
300 DATA("500000", B500000),
303 DATA("576000", B576000),
306 DATA("921600", B921600),
309 DATA("1000000", B1000000),
312 DATA("1152000", B1152000),
315 DATA("1500000", B1500000),
318 DATA("2000000", B2000000),
321 DATA("2500000", B2500000),
324 DATA("3000000", B3000000),
327 DATA("3500000", B3500000),
330 DATA("4000000", B4000000),
336 tbaudrate(char *rate)
338 const SPEEDS *sp = 0;
341 /* The baudrate number can be preceded by a 'B', which is ignored. */
345 for (n = 0; n < SIZEOF(speeds); ++n) {
346 if (n > 0 && (speeds[n].speed <= speeds[n - 1].speed)) {
347 /* if the speeds are not increasing, likely a numeric overflow */
350 if (!CaselessCmp(rate, speeds[n].string)) {
356 err("unknown baud rate %s", rate);
362 * [port-type][test baudrate]:terminal-type
363 * The baud rate tests are: >, <, @, =, !
366 add_mapping(const char *port, char *arg)
374 mapp = typeMalloc(MAP, 1);
375 if (copy == 0 || mapp == 0)
383 cur = maplist = mapp;
389 mapp->porttype = arg;
390 mapp->conditional = 0;
392 arg = strpbrk(arg, "><@=!:");
394 if (arg == 0) { /* [?]term */
395 mapp->type = mapp->porttype;
400 if (arg == mapp->porttype) /* [><@=! baud]:term */
401 termp = mapp->porttype = 0;
405 for (;; ++arg) { /* Optional conditionals. */
408 if (mapp->conditional & GT)
410 mapp->conditional |= LT;
413 if (mapp->conditional & LT)
415 mapp->conditional |= GT;
418 case '=': /* Not documented. */
419 mapp->conditional |= EQ;
422 mapp->conditional |= NOT;
431 if (mapp->conditional)
434 } else { /* Optional baudrate. */
435 arg = strchr(p = arg, ':');
439 mapp->speed = tbaudrate(p);
444 /* Terminate porttype, if specified. */
448 /* If a NOT conditional, reverse the test. */
449 if (mapp->conditional & NOT)
450 mapp->conditional = ~mapp->conditional & (EQ | GT | LT);
452 /* If user specified a port with an option flag, set it. */
455 if (mapp->porttype) {
457 err("illegal -m option format: %s", copy);
459 mapp->porttype = port;
463 (void) printf("port: %s\n", mapp->porttype ? mapp->porttype : "ANY");
464 (void) printf("type: %s\n", mapp->type);
465 (void) printf("conditional: ");
467 if (mapp->conditional & GT) {
471 if (mapp->conditional & EQ) {
472 (void) printf("%sEQ", p);
475 if (mapp->conditional & LT)
476 (void) printf("%sLT", p);
477 (void) printf("\nspeed: %d\n", mapp->speed);
482 * Return the type of terminal to use for a port of type 'type', as specified
483 * by the first applicable mapping in 'map'. If no mappings apply, return
487 mapped(const char *type)
492 for (mapp = maplist; mapp; mapp = mapp->next)
493 if (mapp->porttype == 0 || !strcmp(mapp->porttype, type)) {
494 switch (mapp->conditional) {
495 case 0: /* No test specified. */
499 match = ((int) ospeed == mapp->speed);
502 match = ((int) ospeed >= mapp->speed);
505 match = ((int) ospeed > mapp->speed);
508 match = ((int) ospeed <= mapp->speed);
511 match = ((int) ospeed < mapp->speed);
519 /* No match found; return given type. */
523 /**************************************************************************
527 **************************************************************************/
530 * Figure out what kind of terminal we're dealing with, and then read in
534 get_termcap_entry(int fd, char *userarg)
553 /* Try the environment. */
554 if ((ttype = getenv("TERM")) != 0)
557 if ((ttypath = ttyname(fd)) != 0) {
558 p = _nc_basename(ttypath);
561 * We have the 4.3BSD library call getttynam(3); that means
562 * there's an /etc/ttys to look up device-to-type mappings in.
563 * Try ttyname(3); check for dialup or other mapping.
565 if ((t = getttynam(p))) {
570 if ((fp = fopen("/etc/ttytype", "r")) != 0
571 || (fp = fopen("/etc/ttys", "r")) != 0) {
575 while (fgets(buffer, sizeof(buffer) - 1, fp) != 0) {
576 for (s = buffer, t = d = 0; *s; s++) {
577 if (isspace(UChar(*s)))
581 else if (d == 0 && s != buffer && s[-1] == '\0')
584 if (t != 0 && d != 0 && !strcmp(d, p)) {
592 #endif /* HAVE_GETTTYNAM */
595 /* If still undefined, use "unknown". */
598 map:ttype = mapped(ttype);
601 * If not a path, remove TERMCAP from the environment so we get a
602 * real entry from /etc/termcap. This prevents us from being fooled
603 * by out of date stuff in the environment.
606 if ((p = getenv("TERMCAP")) != 0 && !_nc_is_abs_path(p)) {
607 /* 'unsetenv("TERMCAP")' is not portable.
608 * The 'environ' array is better.
611 for (n = 0; environ[n] != 0; n++) {
612 if (!strncmp("TERMCAP=", environ[n], (size_t) 8)) {
613 while ((environ[n] = environ[n + 1]) != 0) {
622 * ttype now contains a pointer to the type of the terminal.
623 * If the first character is '?', ask the user.
625 if (ttype[0] == '?') {
626 if (ttype[1] != '\0')
627 ttype = askuser(ttype + 1);
631 /* Find the terminfo entry. If it doesn't exist, ask the user. */
632 while (setupterm((NCURSES_CONST char *) ttype, fd, &errret)
635 (void) fprintf(stderr, "%s: unknown terminal type %s\n",
636 _nc_progname, ttype);
639 (void) fprintf(stderr,
640 "%s: can't initialize terminal type %s (error %d)\n",
641 _nc_progname, ttype, errret);
644 ttype = askuser(ttype);
647 tgetflag("am"); /* force lib_termcap.o to be linked for 'ospeed' */
652 /**************************************************************************
656 **************************************************************************/
659 * Convert the obsolete argument forms into something that getopt can handle.
660 * This means that -e, -i and -k get default arguments supplied for them.
663 obsolete(char **argv)
665 for (; *argv; ++argv) {
666 char *parm = argv[0];
668 if (parm[0] == '-' && parm[1] == '\0') {
669 argv[0] = strdup("-q");
674 || (argv[1] && argv[1][0] != '-')
675 || (parm[1] != 'e' && parm[1] != 'i' && parm[1] != 'k')
676 || (parm[2] != '\0'))
678 switch (argv[0][1]) {
680 argv[0] = strdup("-e^H");
683 argv[0] = strdup("-i^C");
686 argv[0] = strdup("-k^U");
693 print_shell_commands(const char *ttype)
700 * Figure out what shell we're using. A hack, we look for an
701 * environmental variable SHELL ending in "csh".
703 if ((var = getenv("SHELL")) != 0
704 && ((len = (int) strlen(leaf = _nc_basename(var))) >= 3)
705 && !strcmp(leaf + len - 3, "csh"))
706 p = "set noglob;\nsetenv TERM %s;\nunset noglob;\n";
709 (void) printf(p, ttype);
715 #define SKIP(s) /* nothing */
716 #define KEEP(s) s "\n"
717 static const char msg[] =
721 SKIP(" -a arpanet (obsolete)")
722 KEEP(" -c set control characters")
723 SKIP(" -d dialup (obsolete)")
724 KEEP(" -e ch erase character")
725 KEEP(" -I no initialization strings")
726 KEEP(" -i ch interrupt character")
727 KEEP(" -k ch kill character")
728 KEEP(" -m mapping map identifier to type")
729 SKIP(" -p plugboard (obsolete)")
730 KEEP(" -Q do not output control key settings")
731 KEEP(" -q display term only, do no changes")
732 KEEP(" -r display term on stderr")
733 SKIP(" -S (obsolete)")
734 KEEP(" -s output TERM set command")
735 KEEP(" -V print curses-version")
736 KEEP(" -w set window-size")
738 KEEP("If neither -c/-w are given, both are assumed.")
742 (void) fprintf(stderr, "Usage: %s [options] [terminal]\n", _nc_progname);
744 ExitProgram(EXIT_FAILURE);
751 return (char) ((optarg[0] == '^' && optarg[1] != '\0')
752 ? ((optarg[1] == '?') ? '\177' : CTRL(optarg[1]))
757 main(int argc, char **argv)
759 int ch, noinit, noset, quiet, Sflag, sflag, showterm;
761 int terasechar = -1; /* new erase character */
762 int intrchar = -1; /* new interrupt character */
763 int tkillchar = -1; /* new kill character */
765 bool opt_c = FALSE; /* set control-chars */
766 bool opt_w = FALSE; /* set window-size */
769 my_fd = STDERR_FILENO;
771 noinit = noset = quiet = Sflag = sflag = showterm = 0;
772 while ((ch = getopt(argc, argv, "a:cd:e:Ii:k:m:p:qQrSsVw")) != -1) {
774 case 'c': /* set control-chars */
777 case 'a': /* OBSOLETE: map identifier to type */
778 add_mapping("arpanet", optarg);
780 case 'd': /* OBSOLETE: map identifier to type */
781 add_mapping("dialup", optarg);
783 case 'e': /* erase character */
784 terasechar = arg_to_char();
786 case 'I': /* no initialization strings */
789 case 'i': /* interrupt character */
790 intrchar = arg_to_char();
792 case 'k': /* kill character */
793 tkillchar = arg_to_char();
795 case 'm': /* map identifier to type */
796 add_mapping(0, optarg);
798 case 'p': /* OBSOLETE: map identifier to type */
799 add_mapping("plugboard", optarg);
801 case 'Q': /* don't output control key settings */
804 case 'q': /* display term only */
807 case 'r': /* display term on stderr */
810 case 'S': /* OBSOLETE: output TERM & TERMCAP */
813 case 's': /* output TERM set command */
816 case 'V': /* print curses-version */
817 puts(curses_version());
818 ExitProgram(EXIT_SUCCESS);
819 case 'w': /* set window-size */
828 _nc_progname = _nc_rootname(*argv);
835 if (!opt_c && !opt_w)
836 opt_c = opt_w = TRUE;
838 my_fd = save_tty_settings(&mode, TRUE);
841 ospeed = (NCURSES_OSPEED) cfgetospeed(&mode);
843 ospeed = (NCURSES_OSPEED) mode.sg_ospeed;
846 if (same_program(_nc_progname, PROG_RESET)) {
847 reset_start(stderr, TRUE, FALSE);
848 reset_tty_settings(my_fd, &mode);
850 reset_start(stderr, FALSE, TRUE);
853 ttype = get_termcap_entry(my_fd, *argv);
858 set_window_size(my_fd, &lines, &columns);
862 set_control_chars(&mode, terasechar, intrchar, tkillchar);
863 set_conversions(&mode);
866 if (send_init_strings(my_fd, &oldmode)) {
867 (void) putc('\r', stderr);
868 (void) fflush(stderr);
869 (void) napms(1000); /* Settle the terminal. */
873 update_tty_settings(&oldmode, &mode);
878 (void) printf("%s\n", ttype);
881 (void) fprintf(stderr, "Terminal type is %s.\n", ttype);
883 * If erase, kill and interrupt characters could have been
884 * modified and not -Q, display the changes.
887 print_tty_chars(&oldmode, &mode);
892 err("The -S option is not supported under terminfo.");
895 print_shell_commands(ttype);
898 ExitProgram(EXIT_SUCCESS);