factor: fix comments
[oweals/busybox.git] / coreutils / tty.c
index 975ccdfaaa470224c4e24ef3fc7668524df567fa..359e5bc9314b1a8a416f967eb34ebfa8d192cf30 100644 (file)
@@ -4,29 +4,51 @@
  *
  * Copyright (C) 2003  Manuel Novoa III  <mjn3@codepoet.org>
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+//config:config TTY
+//config:      bool "tty"
+//config:      default y
+//config:      help
+//config:        tty is used to print the name of the current terminal to
+//config:        standard output.
+
+//applet:IF_TTY(APPLET(tty, BB_DIR_USR_BIN, BB_SUID_DROP))
+
+//kbuild:lib-$(CONFIG_TTY) += tty.o
 
 /* BB_AUDIT SUSv4 compliant */
 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/tty.html */
 
+//usage:#define tty_trivial_usage
+//usage:       ""
+//usage:#define tty_full_usage "\n\n"
+//usage:       "Print file name of stdin's terminal"
+//usage:       IF_INCLUDE_SUSv2( "\n"
+//usage:     "\n       -s      Print nothing, only return exit status"
+//usage:       )
+//usage:
+//usage:#define tty_example_usage
+//usage:       "$ tty\n"
+//usage:       "/dev/tty2\n"
+
 #include "libbb.h"
 
 int tty_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
-int tty_main(int argc, char **argv IF_NOT_INCLUDE_SUSv2(UNUSED_PARAM))
+int tty_main(int argc UNUSED_PARAM, char **argv)
 {
        const char *s;
-       IF_INCLUDE_SUSv2(int silent;)   /* Note: No longer relevant in SUSv3. */
+       IF_INCLUDE_SUSv2(int silent;)  /* Note: No longer relevant in SUSv3. */
        int retval;
 
-       xfunc_error_retval = 2; /* SUSv3 requires > 1 for error. */
+       xfunc_error_retval = 2;  /* SUSv3 requires > 1 for error. */
 
        IF_INCLUDE_SUSv2(silent = getopt32(argv, "s");)
-       IF_INCLUDE_SUSv2(argc -= optind;)
-       IF_NOT_INCLUDE_SUSv2(argc -= 1;)
+       IF_INCLUDE_SUSv2(argv += optind;)
+       IF_NOT_INCLUDE_SUSv2(argv += 1;)
 
        /* gnu tty outputs a warning that it is ignoring all args. */
-       bb_warn_ignoring_args(argc);
+       bb_warn_ignoring_args(argv[0]);
 
        retval = EXIT_SUCCESS;