src/config/help.c

   1 /*****************************************************************************
   2  * help.c: command line help
   3  *****************************************************************************
   4  * Copyright (C) 1998-2011 VLC authors and VideoLAN
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <wchar.h>
  29 #include <wctype.h>
  30 #include <limits.h>
  31 #include <float.h>
  32
  33 #include <vlc_common.h>
  34 #include <vlc_modules.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_charset.h>
  37 #include "modules/modules.h"
  38 #include "config/configuration.h"
  39 #include "libvlc.h"
  40
  41 #if defined( _WIN32 )
  42 # include <vlc_charset.h>
  43 # define wcwidth(cp) (cp, 1) /* LOL */
  44 #else
  45 # include <unistd.h>
  46 # include <termios.h>
  47 # include <sys/ioctl.h>
  48 #endif
  49
  50 #if defined( _WIN32 ) && !VLC_WINSTORE_APP
  51 static void ShowConsole (void);
  52 static void PauseConsole (void);
  53 #else
  54 # define ShowConsole() (void)0
  55 # define PauseConsole() (void)0
  56 #endif
  57
  58 static void Help (vlc_object_t *, const char *);
  59 static void Usage (vlc_object_t *, const char *);
  60 static void Version (void);
  61 static void ListModules (vlc_object_t *, bool);
  62
  63 /**
  64  * Returns the console width or a best guess.
  65  */
  66 static unsigned ConsoleWidth(void)
  67 {
  68 #ifdef TIOCGWINSZ
  69     struct winsize ws;
  70
  71     if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0)
  72         return ws.ws_col;
  73 #endif
  74 #ifdef WIOCGETD
  75     struct uwdata uw;
  76
  77     if (ioctl(STDOUT_FILENO, WIOCGETD, &uw) == 0)
  78         return uw.uw_height / uw.uw_vs;
  79 #endif
  80 #if defined (_WIN32) && !VLC_WINSTORE_APP
  81     CONSOLE_SCREEN_BUFFER_INFO buf;
  82
  83     if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &buf))
  84         return buf.dwSize.X;
  85 #endif
  86     return 80;
  87 }
  88
  89 /**
  90  * Checks for help command line options such as --help or --version.
  91  * If one is found, print the corresponding text.
  92  * \return true if a command line options caused some help message to be
  93  * printed, false otherwise.
  94  */
  95 bool config_PrintHelp (vlc_object_t *obj)
  96 {
  97     char *str;
  98
  99     /* Check for short help option */
 100     if (var_InheritBool (obj, "help"))
 101     {
 102         Help (obj, "help");
 103         return true;
 104     }
 105
 106     /* Check for version option */
 107     if (var_InheritBool (obj, "version"))
 108     {
 109         Version();
 110         return true;
 111     }
 112
 113     /* Check for help on modules */
 114     str = var_InheritString (obj, "module");
 115     if (str != NULL)
 116     {
 117         Help (obj, str);
 118         free (str);
 119         return true;
 120     }
 121
 122     /* Check for full help option */
 123     if (var_InheritBool (obj, "full-help"))
 124     {
 125         var_Create (obj, "advanced", VLC_VAR_BOOL);
 126         var_SetBool (obj, "advanced", true);
 127         var_Create (obj, "help-verbose", VLC_VAR_BOOL);
 128         var_SetBool (obj, "help-verbose", true);
 129         Help (obj, "full-help");
 130         return true;
 131     }
 132
 133     /* Check for long help option */
 134     if (var_InheritBool (obj, "longhelp"))
 135     {
 136         Help (obj, "longhelp");
 137         return true;
 138     }
 139
 140     /* Check for module list option */
 141     if (var_InheritBool (obj, "list"))
 142     {
 143         ListModules (obj, false );
 144         return true;
 145     }
 146
 147     if (var_InheritBool (obj, "list-verbose"))
 148     {
 149         ListModules (obj, true);
 150         return true;
 151     }
 152
 153     return false;
 154 }
 155
 156 /*****************************************************************************
 157  * Help: print program help
 158  *****************************************************************************
 159  * Print a short inline help. Message interface is initialized at this stage.
 160  *****************************************************************************/
 161 static inline void print_help_on_full_help( void )
 162 {
 163     putchar('\n');
 164     puts(_("To get exhaustive help, use '-H'."));
 165 }
 166
 167 static const char vlc_usage[] = N_(
 168   "Usage: %s [options] [stream] ...\n"
 169   "You can specify multiple streams on the commandline.\n"
 170   "They will be enqueued in the playlist.\n"
 171   "The first item specified will be played first.\n"
 172   "\n"
 173   "Options-styles:\n"
 174   "  --option  A global option that is set for the duration of the program.\n"
 175   "   -option  A single letter version of a global --option.\n"
 176   "   :option  An option that only applies to the stream directly before it\n"
 177   "            and that overrides previous settings.\n"
 178   "\n"
 179   "Stream MRL syntax:\n"
 180   "  [[access][/demux]://]URL[#[title][:chapter][-[title][:chapter]]]\n"
 181   "  [:option=value ...]\n"
 182   "\n"
 183   "  Many of the global --options can also be used as MRL specific :options.\n"
 184   "  Multiple :option=value pairs can be specified.\n"
 185   "\n"
 186   "URL syntax:\n"
 187   "  file:///path/file              Plain media file\n"
 188   "  http://host[:port]/file        HTTP URL\n"
 189   "  ftp://host[:port]/file         FTP URL\n"
 190   "  mms://host[:port]/file         MMS URL\n"
 191   "  screen://                      Screen capture\n"
 192   "  dvd://[device]                 DVD device\n"
 193   "  vcd://[device]                 VCD device\n"
 194   "  cdda://[device]                Audio CD device\n"
 195   "  udp://[[<source address>]@[<bind address>][:<bind port>]]\n"
 196   "                                 UDP stream sent by a streaming server\n"
 197   "  vlc://pause:<seconds>          Pause the playlist for a certain time\n"
 198   "  vlc://quit                     Special item to quit VLC\n"
 199   "\n");
 200
 201 static void Help (vlc_object_t *p_this, char const *psz_help_name)
 202 {
 203     ShowConsole();
 204
 205     if( psz_help_name && !strcmp( psz_help_name, "help" ) )
 206     {
 207         printf(_(vlc_usage), "vlc");
 208         Usage( p_this, "=core" );
 209         print_help_on_full_help();
 210     }
 211     else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
 212     {
 213         printf(_(vlc_usage), "vlc");
 214         Usage( p_this, NULL );
 215         print_help_on_full_help();
 216     }
 217     else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
 218     {
 219         printf(_(vlc_usage), "vlc");
 220         Usage( p_this, NULL );
 221     }
 222     else if( psz_help_name )
 223     {
 224         Usage( p_this, psz_help_name );
 225     }
 226
 227     PauseConsole();
 228 }
 229
 230 /*****************************************************************************
 231  * Usage: print module usage
 232  *****************************************************************************
 233  * Print a short inline help. Message interface is initialized at this stage.
 234  *****************************************************************************/
 235 #   define COL(x)  "\033[" #x ";1m"
 236 #   define RED     COL(31)
 237 #   define GREEN   COL(32)
 238 #   define YELLOW  COL(33)
 239 #   define BLUE    COL(34)
 240 #   define MAGENTA COL(35)
 241 #   define CYAN    COL(36)
 242 #   define WHITE   COL(0)
 243 #   define GRAY    "\033[0m"
 244 #   define LINE_START      8
 245 #   define PADDING_SPACES 25
 246
 247 static void print_section(const module_t *m, const module_config_t **sect,
 248                           bool color, bool desc)
 249 {
 250     const module_config_t *item = *sect;
 251
 252     if (item == NULL)
 253         return;
 254     *sect = NULL;
 255
 256     printf(color ? RED"   %s:\n"GRAY : "   %s:\n",
 257            module_gettext(m, item->psz_text));
 258     if (desc && item->psz_longtext != NULL)
 259         printf(color ? MAGENTA"   %s\n"GRAY : "   %s\n",
 260                module_gettext(m, item->psz_longtext));
 261 }
 262
 263 static void print_desc(const char *str, unsigned margin, bool color)
 264 {
 265     unsigned width = ConsoleWidth() - margin;
 266
 267     if (color)
 268         fputs(BLUE, stdout);
 269
 270     const char *word = str;
 271     int wordlen = 0, wordwidth = 0;
 272     unsigned offset = 0;
 273     bool newline = true;
 274
 275     while (str[0])
 276     {
 277         uint32_t cp;
 278         size_t charlen = vlc_towc(str, &cp);
 279         if (unlikely(charlen == (size_t)-1))
 280             break;
 281
 282         int charwidth = wcwidth(cp);
 283         if (charwidth < 0)
 284             charwidth = 0;
 285
 286         str += charlen;
 287
 288         if (iswspace(cp))
 289         {
 290             if (!newline)
 291             {
 292                 putchar(' '); /* insert space */
 293                 charwidth = 1;
 294             }
 295             fwrite(word, 1, wordlen, stdout); /* write complete word */
 296             word = str;
 297             wordlen = 0;
 298             wordwidth = 0;
 299             newline = false;
 300         }
 301         else
 302         {
 303             wordlen += charlen;
 304             wordwidth += charwidth;
 305         }
 306
 307         offset += charwidth;
 308         if (offset >= width)
 309         {
 310             if (newline)
 311             {   /* overflow (word wider than line) */
 312                 fwrite(word, 1, wordlen - charlen, stdout);
 313                 word = str - charlen;
 314                 wordlen = charlen;
 315                 wordwidth = charwidth;
 316             }
 317             printf("\n%*s", margin, ""); /* new line */
 318             offset = wordwidth;
 319             newline = true;
 320         }
 321     }
 322
 323     if (!newline)
 324         putchar(' ');
 325     printf(color ? "%s\n"GRAY : "%s\n", word);
 326 }
 327
 328 static int vlc_swidth(const char *str)
 329 {
 330     for (int total = 0;;)
 331     {
 332         uint32_t cp;
 333         size_t charlen = vlc_towc(str, &cp);
 334
 335         if (charlen == 0)
 336             return total;
 337         if (charlen == (size_t)-1)
 338             return -1;
 339         str += charlen;
 340
 341         int w = wcwidth(cp);
 342         if (w == -1)
 343             return -1;
 344         total += w;
 345     }
 346 }
 347
 348 static void print_item(const vlc_object_t *p_this, const module_t *m, const module_config_t *item,
 349                        const module_config_t **section, bool color, bool desc)
 350 {
 351 #ifndef _WIN32
 352 # define OPTION_VALUE_SEP " "
 353 #else
 354 # define OPTION_VALUE_SEP "="
 355 #endif
 356     const char *bra = OPTION_VALUE_SEP "<", *type, *ket = ">";
 357     const char *prefix = NULL, *suffix = NULL;
 358     char *typebuf = NULL;
 359
 360     switch (CONFIG_CLASS(item->i_type))
 361     {
 362         case 0: // hint class
 363             switch (item->i_type)
 364             {
 365                 case CONFIG_HINT_CATEGORY:
 366                 case CONFIG_HINT_USAGE:
 367                     printf(color ? GREEN "\n %s\n" GRAY : "\n %s\n",
 368                            module_gettext(m, item->psz_text));
 369
 370                     if (desc && item->psz_longtext != NULL)
 371                         printf(color ? CYAN " %s\n" GRAY : " %s\n",
 372                                module_gettext(m, item->psz_longtext));
 373                     break;
 374
 375                 case CONFIG_SECTION:
 376                     *section = item;
 377                     break;
 378             }
 379             return;
 380
 381         case CONFIG_ITEM_STRING:
 382         {
 383             type = _("string");
 384
 385             char **ppsz_values, **ppsz_texts;
 386
 387             ssize_t i_count = config_GetPszChoices(VLC_OBJECT(p_this), item->psz_name, &ppsz_values, &ppsz_texts);
 388
 389             if (i_count > 0)
 390             {
 391                 size_t len = 0;
 392
 393                 for (unsigned i = 0; i < i_count; i++)
 394                     len += strlen(ppsz_values[i]) + 1;
 395
 396                 typebuf = malloc(len);
 397                 if (typebuf == NULL)
 398                     goto end_string;
 399
 400                 bra = OPTION_VALUE_SEP "{";
 401                 type = typebuf;
 402                 ket = "}";
 403
 404                 *typebuf = 0;
 405                 for (unsigned i = 0; i < i_count; i++)
 406                 {
 407                     if (i > 0)
 408                         strcat(typebuf, ",");
 409                     strcat(typebuf, ppsz_values[i]);
 410                 }
 411
 412             end_string:
 413                 for (unsigned i = 0; i < i_count; i++)
 414                 {
 415                     free(ppsz_values[i]);
 416                     free(ppsz_texts[i]);
 417                 }
 418                 free(ppsz_values);
 419                 free(ppsz_texts);
 420             }
 421
 422             break;
 423         }
 424         case CONFIG_ITEM_INTEGER:
 425         {
 426             type = _("integer");
 427
 428             int64_t *pi_values;
 429             char **ppsz_texts;
 430
 431             ssize_t i_count = config_GetIntChoices(VLC_OBJECT(p_this), item->psz_name, &pi_values, &ppsz_texts);
 432
 433             if (i_count > 0)
 434             {
 435                 size_t len = 0;
 436
 437                 for (unsigned i = 0; i < i_count; i++)
 438                     len += strlen(ppsz_texts[i])
 439                            + 4 * sizeof (int64_t) + 5;
 440
 441                 typebuf = malloc(len);
 442                 if (typebuf == NULL)
 443                     goto end_integer;
 444
 445                 bra = OPTION_VALUE_SEP "{";
 446                 type = typebuf;
 447                 ket = "}";
 448
 449                 *typebuf = 0;
 450                 for (unsigned i = 0; i < item->list_count; i++)
 451                 {
 452                     if (i != 0)
 453                         strcat(typebuf, ", ");
 454                     sprintf(typebuf + strlen(typebuf), "%"PRIi64" (%s)",
 455                             pi_values[i],
 456                             ppsz_texts[i]);
 457                 }
 458
 459             end_integer:
 460                 for (unsigned i = 0; i < i_count; i++)
 461                     free(ppsz_texts[i]);
 462                 free(pi_values);
 463                 free(ppsz_texts);
 464             }
 465             else if (item->min.i != INT64_MIN || item->max.i != INT64_MAX )
 466             {
 467                 if (asprintf(&typebuf, "%s [%"PRId64" .. %"PRId64"]",
 468                              type, item->min.i, item->max.i) >= 0)
 469                     type = typebuf;
 470                 else
 471                     typebuf = NULL;
 472             }
 473             break;
 474         }
 475         case CONFIG_ITEM_FLOAT:
 476             type = _("float");
 477             if (item->min.f != FLT_MIN || item->max.f != FLT_MAX)
 478             {
 479                 if (asprintf(&typebuf, "%s [%f .. %f]", type,
 480                              item->min.f, item->max.f) >= 0)
 481                     type = typebuf;
 482                 else
 483                     typebuf = NULL;
 484             }
 485             break;
 486
 487         case CONFIG_ITEM_BOOL:
 488             bra = type = ket = "";
 489             prefix = ", --no-";
 490             suffix = item->value.i ? _("(default enabled)")
 491                                    : _("(default disabled)");
 492             break;
 493        default:
 494             return;
 495     }
 496
 497     print_section(m, section, color, desc);
 498
 499     /* Add short option if any */
 500     char shortopt[4];
 501     if (item->i_short != '\0')
 502         sprintf(shortopt, "-%c,", item->i_short);
 503     else
 504         strcpy(shortopt, "   ");
 505
 506     if (CONFIG_CLASS(item->i_type) == CONFIG_ITEM_BOOL)
 507         printf(color ? WHITE"  %s --%s"      "%s%s%s%s%s "GRAY
 508                      : "  %s --%s%s%s%s%s%s ", shortopt, item->psz_name,
 509                prefix, item->psz_name, bra, type, ket);
 510     else
 511         printf(color ? WHITE"  %s --%s"YELLOW"%s%s%s%s%s "GRAY
 512                      : "  %s --%s%s%s%s%s%s ", shortopt, item->psz_name,
 513                "", "",  /* XXX */      bra, type, ket);
 514
 515     /* Wrap description */
 516     int offset = PADDING_SPACES - strlen(item->psz_name)
 517                - strlen(bra) - vlc_swidth(type) - strlen(ket) - 1;
 518     if (CONFIG_CLASS(item->i_type) == CONFIG_ITEM_BOOL)
 519         offset -= strlen(item->psz_name) + vlc_swidth(prefix);
 520     if (offset < 0)
 521     {
 522         putchar('\n');
 523         offset = PADDING_SPACES + LINE_START;
 524     }
 525
 526     printf("%*s", offset, "");
 527     print_desc(module_gettext(m, item->psz_text),
 528                PADDING_SPACES + LINE_START, color);
 529
 530     if (suffix != NULL)
 531     {
 532         printf("%*s", PADDING_SPACES + LINE_START, "");
 533         print_desc(suffix, PADDING_SPACES + LINE_START, color);
 534     }
 535
 536     if (desc && (item->psz_longtext != NULL && item->psz_longtext[0]))
 537     {   /* Wrap long description */
 538         printf("%*s", LINE_START + 2, "");
 539         print_desc(module_gettext(m, item->psz_longtext),
 540                    LINE_START + 2, false);
 541     }
 542
 543     free(typebuf);
 544 }
 545
 546 static bool module_match(const module_t *m, const char *pattern, bool strict)
 547 {
 548     if (pattern == NULL)
 549         return true;
 550
 551     const char *objname = module_get_object(m);
 552
 553     if (strict ? (strcmp(objname, pattern) == 0)
 554                : (strstr(objname, pattern) != NULL))
 555         return true;
 556
 557     for (unsigned i = 0; i < m->i_shortcuts; i++)
 558     {
 559         const char *shortcut = m->pp_shortcuts[i];
 560
 561         if (strict ? (strcmp(shortcut, pattern) == 0)
 562                    : (strstr(shortcut, pattern) != NULL))
 563             return true;
 564     }
 565     return false;
 566 }
 567
 568 static bool plugin_show(const vlc_plugin_t *plugin, bool advanced)
 569 {
 570     for (size_t i = 0; i < plugin->conf.size; i++)
 571     {
 572         const module_config_t *item = plugin->conf.items + i;
 573
 574         if (!CONFIG_ITEM(item->i_type))
 575             continue;
 576         if (item->b_removed)
 577             continue;
 578         if ((!advanced) && item->b_advanced)
 579             continue;
 580         return true;
 581     }
 582     return false;
 583 }
 584
 585 static void Usage (vlc_object_t *p_this, char const *psz_search)
 586 {
 587     bool b_has_advanced = false;
 588     bool found = false;
 589     unsigned i_only_advanced = 0; /* Number of modules ignored because they
 590                                * only have advanced options */
 591     bool strict = false;
 592     if (psz_search != NULL && psz_search[0] == '=')
 593     {
 594         strict = true;
 595         psz_search++;
 596     }
 597
 598     bool color = false;
 599 #ifndef _WIN32
 600     if (isatty(STDOUT_FILENO))
 601         color = var_InheritBool(p_this, "color");
 602 #endif
 603
 604     const bool desc = var_InheritBool(p_this, "help-verbose");
 605     const bool advanced = var_InheritBool(p_this, "advanced");
 606
 607     /* Enumerate the config for each module */
 608     for (const vlc_plugin_t *p = vlc_plugins; p != NULL; p = p->next)
 609     {
 610         const module_t *m = p->module;
 611         const module_config_t *section = NULL;
 612         const char *objname = module_get_object(m);
 613
 614         if (p->conf.count == 0)
 615             continue; /* Ignore modules without config options */
 616         if (!module_match(m, psz_search, strict))
 617             continue;
 618         found = true;
 619
 620         if (!plugin_show(p, advanced))
 621         {   /* Ignore plugins with only advanced config options if requested */
 622             i_only_advanced++;
 623             continue;
 624         }
 625
 626         /* Print name of module */
 627         printf(color ? "\n " GREEN "%s" GRAY " (%s)\n" : "\n %s (%s)\n",
 628                module_gettext(m, m->psz_longname), objname);
 629         if (m->psz_help != NULL)
 630             printf(color ? CYAN" %s\n"GRAY : " %s\n",
 631                    module_gettext(m, m->psz_help));
 632
 633         /* Print module options */
 634         for (size_t j = 0; j < p->conf.size; j++)
 635         {
 636             const module_config_t *item = p->conf.items + j;
 637
 638             if (item->b_removed)
 639                 continue; /* Skip removed options */
 640             if (item->b_advanced && !advanced)
 641             {   /* Skip advanced options unless requested */
 642                 b_has_advanced = true;
 643                 continue;
 644             }
 645             print_item(p_this, m, item, &section, color, desc);
 646         }
 647     }
 648
 649     if( b_has_advanced )
 650         printf(color ? "\n" WHITE "%s" GRAY " %s\n"
 651                      : "\n%s %s\n", _( "Note:" ), _( "add --advanced to your "
 652                                      "command line to see advanced options."));
 653     if( i_only_advanced > 0 )
 654     {
 655         printf(color ? "\n" WHITE "%s" GRAY " " : "\n%s ", _( "Note:" ) );
 656         printf(vlc_ngettext("%u module was not displayed because it only has "
 657                "advanced options.\n", "%u modules were not displayed because "
 658                "they only have advanced options.\n", i_only_advanced),
 659                i_only_advanced);
 660     }
 661     else if (!found)
 662         printf(color ? "\n" WHITE "%s" GRAY "\n" : "\n%s\n",
 663                _("No matching module found. Use --list or "
 664                  "--list-verbose to list available modules."));
 665 }
 666
 667 /*****************************************************************************
 668  * ListModules: list the available modules with their description
 669  *****************************************************************************
 670  * Print a list of all available modules (builtins and plugins) and a short
 671  * description for each one.
 672  *****************************************************************************/
 673 static void ListModules (vlc_object_t *p_this, bool b_verbose)
 674 {
 675     bool color = false;
 676
 677     ShowConsole();
 678 #ifndef _WIN32
 679     if (isatty(STDOUT_FILENO))
 680         color = var_InheritBool(p_this, "color");
 681 #else
 682     (void) p_this;
 683 #endif
 684
 685     /* List all modules */
 686     size_t count;
 687     module_t **list = module_list_get (&count);
 688
 689     /* Enumerate each module */
 690     for (size_t j = 0; j < count; j++)
 691     {
 692         module_t *p_parser = list[j];
 693         const char *objname = module_get_object (p_parser);
 694         printf(color ? GREEN"  %-22s "WHITE"%s\n"GRAY : "  %-22s %s\n",
 695                objname, module_gettext(p_parser, p_parser->psz_longname));
 696
 697         if( b_verbose )
 698         {
 699             const char *const *pp_shortcuts = p_parser->pp_shortcuts;
 700             for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
 701                 if( strcmp( pp_shortcuts[i], objname ) )
 702                     printf(color ? CYAN"   s %s\n"GRAY : "   s %s\n",
 703                            pp_shortcuts[i]);
 704             if (p_parser->psz_capability != NULL)
 705                 printf(color ? MAGENTA"   c %s (%d)\n"GRAY : "   c %s (%d)\n",
 706                        p_parser->psz_capability, p_parser->i_score);
 707         }
 708     }
 709     module_list_free (list);
 710     PauseConsole();
 711 }
 712
 713 /*****************************************************************************
 714  * Version: print complete program version
 715  *****************************************************************************
 716  * Print complete program version and build number.
 717  *****************************************************************************/
 718 static void Version( void )
 719 {
 720     ShowConsole();
 721     printf(_("VLC version %s (%s)\n"), VERSION_MESSAGE, psz_vlc_changeset);
 722     printf(_("Compiled by %s on %s (%s)\n"), VLC_CompileBy(),
 723            VLC_CompileHost(), __DATE__" "__TIME__ );
 724     printf(_("Compiler: %s\n"), VLC_Compiler());
 725     fputs(LICENSE_MSG, stdout);
 726     PauseConsole();
 727 }
 728
 729 #if defined( _WIN32 ) && !VLC_WINSTORE_APP
 730 /*****************************************************************************
 731  * ShowConsole: On Win32, create an output console for debug messages
 732  *****************************************************************************
 733  * This function is useful only on Win32.
 734  *****************************************************************************/
 735 static void ShowConsole( void )
 736 {
 737     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
 738
 739     if( !AllocConsole() ) return;
 740
 741     /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
 742      * Unicode/locale subsystem. By default, we have the obsolecent OEM code
 743      * page (e.g. CP437 or CP850). */
 744     SetConsoleOutputCP (GetACP ());
 745     SetConsoleTitle (TEXT("VLC media player version ") TEXT(PACKAGE_VERSION));
 746
 747     freopen( "CONOUT$", "w", stderr );
 748     freopen( "CONIN$", "r", stdin );
 749
 750     if( freopen( "vlc-help.txt", "wt", stdout ) != NULL )
 751     {
 752         fputs( "\xEF\xBB\xBF", stdout );
 753         fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
 754     }
 755     else
 756         freopen( "CONOUT$", "w", stdout );
 757 }
 758
 759 /*****************************************************************************
 760  * PauseConsole: On Win32, wait for a key press before closing the console
 761  *****************************************************************************
 762  * This function is useful only on Win32.
 763  *****************************************************************************/
 764 static void PauseConsole( void )
 765 {
 766     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
 767
 768     utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
 769     getchar();
 770     fclose( stdout );
 771 }
 772 #endif