version.h File Reference

Display version and copyright about NeoMutt. More...

#include <stdbool.h>
#include <stdio.h>

Include dependency graph for version.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	print_version (FILE *fp)
	Print system and compile info to a file.
bool	print_copyright (void)
	Print copyright message.
bool	feature_enabled (const char *name)
	Test if a compile-time feature is enabled.

Detailed Description

Display version and copyright about NeoMutt.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file version.h.

Function Documentation

print_version()

bool print_version

(

FILE *

fp

)

Print system and compile info to a file.

Parameters

fp	File to print to

Return values

true	Text displayed

Print information about the current system NeoMutt is running on. Also print a list of all the compile-time information.

Definition at line 388 of file version.c.

{
  if (!fp)
    return false;
 
  struct utsname uts = { 0 };
  bool tty = isatty(fileno(fp));
 
  const char *col_cyan = "";
  const char *col_bold = "";
  const char *col_end = "";
 
  if (tty)
  {
    col_cyan = "\033[1;36m"; // Escape, cyan
    col_bold = "\033[1m";    // Escape, bold
    col_end = "\033[0m";     // Escape, end
  }
 
  fprintf(fp, "%s%s%s\n", col_cyan, mutt_make_version(), col_end);
  fprintf(fp, "%s\n", _(Notice));
 
  uname(&uts);
 
  fprintf(fp, "%sSystem:%s ", col_bold, col_end);
#ifdef SCO
  fprintf(fp, "SCO %s", uts.release);
#else
  fprintf(fp, "%s %s", uts.sysname, uts.release);
#endif
 
  fprintf(fp, " (%s)", uts.machine);
 
  fprintf(fp, "\n%sncurses:%s %s", col_bold, col_end, curses_version());
#ifdef NCURSES_VERSION
  fprintf(fp, " (compiled with %s.%d)", NCURSES_VERSION, NCURSES_VERSION_PATCH);
#endif
 
#ifdef _LIBICONV_VERSION
  fprintf(fp, "\n%slibiconv:%s %d.%d", col_bold, col_end,
          _LIBICONV_VERSION >> 8, _LIBICONV_VERSION & 0xff);
#endif
 
#ifdef HAVE_LIBIDN
  fprintf(fp, "\n%slibidn2:%s %s", col_bold, col_end, mutt_idna_print_version());
#endif
 
#ifdef CRYPT_BACKEND_GPGME
  fprintf(fp, "\n%sGPGME:%s %s", col_bold, col_end, mutt_gpgme_print_version());
#endif
 
#ifdef USE_SSL_OPENSSL
#ifdef LIBRESSL_VERSION_TEXT
  fprintf(fp, "\n%sLibreSSL:%s %s", col_bold, col_end, LIBRESSL_VERSION_TEXT);
#endif
#ifdef OPENSSL_VERSION_TEXT
  fprintf(fp, "\n%sOpenSSL:%s %s", col_bold, col_end, OPENSSL_VERSION_TEXT);
#endif
#endif
 
#ifdef USE_SSL_GNUTLS
  fprintf(fp, "\n%sGnuTLS:%s %s", col_bold, col_end, GNUTLS_VERSION);
#endif
 
#ifdef HAVE_NOTMUCH
  fprintf(fp, "\n%slibnotmuch:%s %d.%d.%d", col_bold, col_end, LIBNOTMUCH_MAJOR_VERSION,
          LIBNOTMUCH_MINOR_VERSION, LIBNOTMUCH_MICRO_VERSION);
#endif
 
#ifdef HAVE_PCRE2
  {
    char version[24] = { 0 };
    pcre2_config(PCRE2_CONFIG_VERSION, version);
    fprintf(fp, "\n%sPCRE2:%s %s", col_bold, col_end, version);
  }
#endif
 
#ifdef USE_HCACHE
  const char *backends = store_backend_list();
  fprintf(fp, "\n%sstorage:%s %s", col_bold, col_end, backends);
  FREE(&backends);
#ifdef USE_HCACHE_COMPRESSION
  backends = compress_list();
  fprintf(fp, "\n%scompression:%s %s", col_bold, col_end, backends);
  FREE(&backends);
#endif
#endif
 
  rstrip_in_place((char *) configure_options);
  fprintf(fp, "\n\n%sConfigure options:%s %s\n", col_bold, col_end, (char *) configure_options);
 
  rstrip_in_place((char *) cc_cflags);
  fprintf(fp, "\n%sCompilation CFLAGS:%s %s\n", col_bold, col_end, (char *) cc_cflags);
 
  fprintf(fp, "\n%s%s%s\n", col_bold, _("Compile options:"), col_end);
  print_compile_options(CompOpts, fp);
 
  if (DebugOpts[0].name)
  {
    fprintf(fp, "\n%s%s%s\n", col_bold, _("Devel options:"), col_end);
    print_compile_options(DebugOpts, fp);
  }
 
  fprintf(fp, "\n");
#ifdef DOMAIN
  fprintf(fp, "DOMAIN=\"%s\"\n", DOMAIN);
#endif
#ifdef ISPELL
  fprintf(fp, "ISPELL=\"%s\"\n", ISPELL);
#endif
  fprintf(fp, "MAILPATH=\"%s\"\n", MAILPATH);
  fprintf(fp, "PKGDATADIR=\"%s\"\n", PKGDATADIR);
  fprintf(fp, "SENDMAIL=\"%s\"\n", SENDMAIL);
  fprintf(fp, "SYSCONFDIR=\"%s\"\n", SYSCONFDIR);
 
  fprintf(fp, "\n");
  fputs(_(ReachingUs), fp);
 
  fflush(fp);
  return !ferror(fp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_copyright()

bool print_copyright

(

void

)

Print copyright message.

Return values

true	Text displayed

Print the authors' copyright messages, the GPL license and some contact information for the NeoMutt project.

Definition at line 517 of file version.c.

{
  puts(mutt_make_version());
  puts(Copyright);
  puts(_(Thanks));
  puts(_(License));
  puts(_(ReachingUs));
 
  fflush(stdout);
  return !ferror(stdout);
}

Here is the call graph for this function:

Here is the caller graph for this function:

feature_enabled()

bool feature_enabled

(

const char *

name

)

Test if a compile-time feature is enabled.

Parameters

name	Compile-time symbol of the feature

Return values

true	Feature enabled
false	Feature not enabled, or not compiled in

Many of the larger features of neomutt can be disabled at compile time. They define a symbol and use ifdef's around their code. The symbols are mirrored in "CompileOptions CompOpts[]" in this file.

This function checks if one of these symbols is present in the code.

These symbols are also seen in the output of "neomutt -v".

Definition at line 544 of file version.c.

{
  if (!name)
    return false;
  for (int i = 0; CompOpts[i].name; i++)
  {
    if (mutt_str_equal(name, CompOpts[i].name))
    {
      return CompOpts[i].enabled;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function: