Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
System-Info(1)		    General Commands Manual		System-Info(1)

NAME
       System-Info -- Show system information and banners

SYNOPSIS
       System-Info		   [-h		      |		       --help]
		   [-S scripts_directory | --scripts scripts_directory]

DESCRIPTION
       System-Info displays basic status information about the	system:	 host-
       name, uptime, CPU, memory statistics, disk space	statistics, SSH	public
       key  hashes, and	networking information.	Furthermore, it	can be config-
       ured to show one	or more	banners	(for example, a	project	name). System-
       Info can	be configured to be automatically run when logging in, provid-
       ing the user an up-to-date overview of the system.
       One main	purpose	of System-Info is to run  on  login,  to  particularly
       show  a	nice login banner (for example,	a project or company logo) and
       then present the	basic system information. For  this  purpose,  System-
       Info  can  be  configured  with banner scripts (by default looked up in
       /etc/system-info.d   or	 /usr/local/etc/system-info.d),	  which	   are
       processed in alphabetically descending order by file name, like:
       * 95-application-logo,
       * 90-project-logo,
       * 60-department-logo,
       * 50-company-logo,
       * 01-example.
       The  names of all scripts MUST begin with two decimal numbers. That is,
       scripts must be named [0-9][0-9]... to be processed by System-Info!  If
       one of the scripts exits	with non-zero exit  code,  the	processing  of
       further	banner scripts is stopped. This	can be used for	preconfiguring
       a system	for example with a department and company logo,	where the com-
       pany logo script	terminates further processing. A modified system for a
       certain project can add a project logo as well. The project logo	script
       may terminate further processing, not showing  department  and  company
       logos.  This may	be combined with packaging scripts, for	example	adding
       an application logo as part of the application's	install	package	 (like
       adding a	script 95-application-logo).

ARGUMENTS
       The following options are available:

       -h | --help
	       Prints command-line parameters.

       -S scripts_directory | --scripts	scripts_directory
	       Sets the	directory to look for scripts, for example to test own
	       scripts.	 Default: /etc/system-info.d or	/usr/local/etc/system-
	       info.d.

EXAMPLES
       System-Info

       System-Info -S /usr/share/System-Info

       System-Info -S ~/src/system-info/src/system-info.d

       System-Info --scripts ~/my-system-info-scripts

       LANGUAGE=nb System-Info

       LANGUAGE=de_AT System-Info

       LANGUAGE=nb System-Info -S /usr/share/System-Info

System-Info		       December	13, 2024		System-Info(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=System-Info&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help