Skip to content

Instantly share code, notes, and snippets.

@woodruffw
Created March 31, 2015 21:25
Show Gist options
  • Select an option

  • Save woodruffw/1cb8a95766f9fee4fbd4 to your computer and use it in GitHub Desktop.

Select an option

Save woodruffw/1cb8a95766f9fee4fbd4 to your computer and use it in GitHub Desktop.
screenfetch-c.html
<!-- Creator : groff version 1.22.2 -->
<!-- CreationDate: Tue Mar 31 17:15:32 2015 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>screenfetch-c</title>
</head>
<body>
<h1 align="center">screenfetch-c</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#COMPATIBILITY">COMPATIBILITY</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
<a href="#RELEASE HISTORY">RELEASE HISTORY</a><br>
<a href="#BUGS AND ERRATIC BEHAVIOR">BUGS AND ERRATIC BEHAVIOR</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#EXIT STATUS">EXIT STATUS</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
- Display computer information and an ASCII logo</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
[<i>OPTIONS</i>]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
is a C rewrite of the original screenFetch, which was
written in bash by Brett Bohnenkamper. Like the original, it
displays both an ASCII logo determined by the
computer&rsquo;s OS and a variety of statistics, including
kernel type, ram, uptime, and so forth.</p>
<h2>COMPATIBILITY
<a name="COMPATIBILITY"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Supported OSes:
Microsoft Windows, Mac OS X, FreeBSD, OpenBSD, NetBSD,
DragonFlyBSD, Solaris and its derivatives, and most
Linux-kernel based distributions.</p>
<p style="margin-left:11%; margin-top: 1em"><i>Note:</i> If
you are using manual mode to provide <b>screenfetch-c</b>
with system information, you will need to enter the
distribution name EXACTLY as written below: Arch Linux,
ParabolaGNU/Linux-libre, Chakra, Manjaro, Frugalware,
Ubuntu, LinuxMint, SolusOS, Debian, LMDE, CrunchBang,
Peppermint, LinuxDeepin, Trisquel, elementary OS, Backtrack
Linux, Slackware, Gentoo, Sabayon, Funtoo, Fuduntu, Fedora,
OpenSUSE, Red Hat Linux, Mandriva, Mandrake, Mageia, Viperr,
Andoid, Linux, Solaris, Angstrom.</p>
<p style="margin-left:11%; margin-top: 1em">Supported
shells: GNU bash, csh, zsh, ksh, fish, dash, ash.</p>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;v</b>,
<b>&minus;&minus;verbose</b></p>
<p style="margin-left:11%; margin-top: 1em">Enable verbose
mode, which prints out detection information.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;s</b>,
<b>&minus;&minus;screenshot</b></p>
<p style="margin-left:11%; margin-top: 1em">Take a
screenshot after completing the output. On non&minus;Windows
systems, this will save a file titled
&rsquo;<i>screenfetch_screenshot.png</i>&rsquo; in
<b>$HOME</b>. On Windows, this will save the screenshot in
the system clipboard.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;n</b>,
<b>&minus;&minus;no-logo</b></p>
<p style="margin-left:11%; margin-top: 1em">Strip output of
ASCII logo - print information only.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;D</b>,
<b>&minus;&minus;distro</b> <i>DISTRO</i></p>
<p style="margin-left:11%; margin-top: 1em">Set the distro
outputted by <b>screenfetch-c</b>.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;E</b>,
<b>&minus;&minus;suppress-errors</b></p>
<p style="margin-left:11%; margin-top: 1em">Suppress (most)
error messages as they arise.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;p</b>,
<b>&minus;&minus;portrait</b></p>
<p style="margin-left:11%; margin-top: 1em">Print output in
portrait mode.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;V</b>,
<b>&minus;&minus;version</b></p>
<p style="margin-left:11%; margin-top: 1em">Display the
version of <b>screenfetch-c</b> currently being used.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;h</b>,
<b>&minus;&minus;help</b></p>
<p style="margin-left:11%; margin-top: 1em">Displays help
and compatibility information.</p>
<p style="margin-left:11%; margin-top: 1em"><b>&minus;L</b>,
<b>&minus;&minus;logo-only</b> <i>DISTRO</i></p>
<p style="margin-left:11%; margin-top: 1em">Output only the
ASCII logo associated with that distro. Follows the general
naming conventions of the <b>&minus;D</b> flag, but with
&quot;OS X&quot;, &quot;Windows&quot;, and
&quot;Solaris&quot; as possibilities as well.</p>
<h2>ENVIRONMENT
<a name="ENVIRONMENT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
uses the following environment variables:</p>
<p style="margin-left:11%; margin-top: 1em"><b>USER</b> -
Used on BSD to determine the current user.</p>
<p style="margin-left:11%; margin-top: 1em"><b>HOME</b> -
Used to determine the user&rsquo;s home directory.</p>
<p style="margin-left:11%; margin-top: 1em"><b>SHELL</b> -
Used to determine the active shell.</p>
<p style="margin-left:11%; margin-top: 1em">Each of these
variables must be defined properly in order for
<b>screenfetch-c</b> to function as intended.</p>
<h2>RELEASE HISTORY
<a name="RELEASE HISTORY"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>0.1</i> -
ALPHA - INCOMPLETE, UNCOMPILED</p>
<p style="margin-left:11%; margin-top: 1em"><i>0.5</i> -
ALPHA - INCOMPLETE, TEST COMPILED</p>
<p style="margin-left:11%; margin-top: 1em"><i>1.0</i> -
BETA - LACKING MINOR PARTS, STABLE, WORKING ON MOST
SYSTEMS</p>
<p style="margin-left:11%; margin-top: 1em"><i>1.1</i> -
BETA - NEARLY COMPLETE, MINOR BUGS AND GPU DETECTION NOT
FINISHED</p>
<p style="margin-left:11%; margin-top: 1em"><i>1.2</i> -
RELEASE - WORKS ON THE MAJORITY OF SYSTEMS</p>
<p style="margin-left:11%; margin-top: 1em"><i>1.3</i> -
RELEASE - SIGNIFICANT REFACTORING AND PERFORMANCE
IMPROVEMENTS</p>
<p style="margin-left:11%; margin-top: 1em"><i>1.4</i> -
RELEASE - CODE REDUCTION, PERFORMANCE IMPROVEMENTS AND
NATIVIZATION ON LINUX</p>
<h2>BUGS AND ERRATIC BEHAVIOR
<a name="BUGS AND ERRATIC BEHAVIOR"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Shell version
detection relies of very specific naming schemes and may
appear incorrectly if any shell changes its versioning
scheme.</p>
<p style="margin-left:11%; margin-top: 1em">DragonFly BSD
systems with more than 4GiB of RAM may have their RAM stats
displayed incorrectly, as 32-bit integers are used in
sysctl.</p>
<p style="margin-left:11%; margin-top: 1em">Memory
detection on Linux systems includes swap/buffer RAM in used
RAM, not free RAM. While this is not a bug per se, it may
contradict figures from other utilities (which factor out
swap/buffer RAM).</p>
<p style="margin-left:11%; margin-top: 1em">Found a bug or
issue? Please tell me about it:
<i>http://github.com/woodruffw/screenfetch-c</i></p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i><b>screenfetch-c</b></i>
has two built-in diagnostic output modes: verbose (disabled
by default) and error (enabled by default). If a serious or
fatal error occurs, the user will be notified via error
(stderr). Otherwise, the user may choose to enable the
verbose mode, which display real-time detection.</p>
<h2>EXIT STATUS
<a name="EXIT STATUS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
returns <b>EXIT_SUCCESS</b> in all circumstances except for
malformed argument strings. For example,
<b>screenfetch-c</b> will return <b>EXIT_FAILURE</b> if
flagged with <b>&minus;D</b> but not given an additional
argument.</p>
<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>screenfetch-c</b>
was written and is maintained by William Woodruff
(<i>william @ tuffbizz.com</i>)</p>
<p style="margin-left:11%; margin-top: 1em">The original
screenFetch was written by Brett Bohnenkamper (<i>kittykatt
@ archlinux.us</i>)</p>
<p style="margin-left:11%; margin-top: 1em">For a list of
contributors to <b>screenfetch-c</b>, please refer to the
CONTRIBUTORS file.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>screenFetch</i>(1),
<i>archey</i>(1)</p>
<hr>
</body>
</html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment