ramdefrag.1

RAM Defragmentation tools

.\" ramdefrag man page
.\" $Id: ramdefrag.1,v 1.21 2005/10/09 15:19:57 knilch Exp $
.\"
.\" ***** We don't make mistakes - we have happy little accidents. *****
.\"
.\" some troff/nroff fun (yeah i know, it doesn't work - FIXME):
.hy 0
.nh
.if n .na
.\" now the real deal:
.TH RAMDEFRAG 1 "BT, 63. Bcy 3171" "ramdefrag 0.4.0" "System Tuning"
.
.SH NAME
ramdefrag \- optimize memory performance
.
.SH SYNOPSIS
.B ramdefrag
.RI [ options ]
.PP
.B ramdefrag
.RI { -c | --cli }
.RI [ options ]
.
.SH DESCRIPTION
.B ramdefrag
uses secret technologies to optimize RAM performance.
By its visionary design, it makes your system run faster, while simultaneously
increasing its stability.  Testers all over the world report that it
also does a great job in delivering world peace and harmony.
.
.SH OPTIONS
When no contrary options have been given,
.B ramdefrag
uses its GTK+ graphical user interface. To change this behaviour, see \*(lqUser
Interface Selection\*(rq below.
.
.SS General Options
The following options are independent of the currently used user interface.
.TP
\fB\-h\fP, \fB\-\-help\fP
display usage information and exit.
.TP
\fB\-V\fP, \fB\-\-version\fP
display
.B ramdefrag
version and exit.
.TP
\fB\-H\fP, \fB\-\-nohorsti\fP
disable usage of 
.SM H.O.R.S.T.I.
This option won't enable the 
\fIHybrid Operating Random System Transition Interface\fP,
which is needed to access memory structures without superuser
privileges.
.SM H.O.R.S.T.I.
usage is implicitly disabled when
.B ramdefrag
is run by the superuser.
.TP
\fB\-n\fP, \fB\-\-dry-run\fP
\*(lqsimulation mode\*(rq \- just simulate optimizing, but don't
touch RAM.
.TP
\fB\-v\fP, \fB\-\-verbose\fP
increase verbosity.  For debugging purposes, this option can be given
more than once.
.
.SS User Interface Selection
.TP
\fB\-g\fP, \fB\-\-gtk\fP
use the GTK+ user interface. This is the default.
.TP
\fB\-c\fP, \fB\-\-cli\fP
use a non-interactive, non-graphical command-line interface (CLI).
When using this option, a defragmentation method has to be specified;
see \*(lqCLI Options\*(rq below.
.
.SS Command-Line Interface Options
These options are only valid when the command-line interface was
enabled via the \fB\-\-cli\fP (\fB\-c\fP) option. Keep in mind that
you have to explicitly set a defragmentation algorithm by using
one of the \fB\-s\fP, \fB\-d\fP or \fB\-o\fP options.
.TP
\fB\-a\fP, \fB\-\-analyze\fP
don't do defragmentation; just analyze the actual state of the
memory. This option currently is only useful in conjunction with
the \fB\-f\fP option, see below.
.TP
\fB\-s\fP, \fB\-\-std-alg\fP
use the default defragmentation algorithm.
.TP
\fB\-d\fP, \fB\-\-deep-alg\fP
use the \*(lqdeep\*(rq defragmentation algorithm.
.TP
\fB\-o\fP, \fB\-\-opt-alg\fP
use special optimized defragmentation.
.TP
\fB\-p\fP, \fB\-\-progress\fP
show a progress bar made of hash marks.
.IP
\fBWARNING:\fP use of the \fB\-p\fP or \fB\-\-progress\fP option in the
\fIEuropean Union\fP may be subject to the software patent no.
\fBEP 0394160\fP, which is valid until the year 2010, and may have legal
consequences.  Use of this option in the \fIUnited States\fP isn't
recommended because of similar reasons.
.TP
\fB\-S\fP, \fB\-\-nostatus\fP
do not show current defragmentation state. If this option is not
in use, the defragmentation states are printed as defragmentation
moves on.
.TP
\fB\-f\fP, \fB\-\-statistics\fP, \fB\-\-fin\-stats\fP
show a detailed report after defragmentation or analysis has
finished.
.TP
\fB\-b\fP, \fB\-\-batchmode\fP
output machine\-readable rather than human\-readable statistics.  This
option can be used e.g. in shell scripts to do automatic defragmentation
runs.  It implicitely sets the \fB\-\-nostatus\fP and the
\fB\-\-statistics\fP options.  After defragmentation, the machine\-readable
output consists of two lines, each of which consist of three values:
the percentage of fragmented pages, the system speed index, and the number
of deep fragmentation nodes.  The first line represents the status before,
the second line the status after the defragmentation run.
.
.SS Some GTK+-Options
Setting these options is only valid when the GTK+ graphical user
interface is used (currently, this is the default, but you can
explicitly enable it with the \fB\-g\fP or \fB\-\-gtk\fP option).
.TP
.B \-\-display \fI<display>\fP
The name of the X display to open instead of the one specified in the
.B DISPLAY
environment variable.
.TP
.B \-\-sync
Makes all X requests synchronously. This is a useful option for debugging,
but it will slow down the performance considerably.
.
.SH EXAMPLES
Start
.B ramdefrag
in GUI mode:
.IP
ramdefrag
.PP
Start
.B ramdefrag
without GUI, use special optimized defragmentation algorithms, and display
a progress bar while defragmentation is running:
.IP
ramdefrag \-\-cli \-\-std\-alg \-\-progress
.PP
or
.IP
ramdefrag \-csp
.PP
Start
.B ramdefrag
without GUI, just analyze RAM (without defragmentation), display a progress
bar while the memory is being analyzed, and display a final report about
the outcome:
.IP
ramdefrag \-\-cli \-\-analyze \-\-progress \-\-statistics
.PP
or
.IP
ramdefrag \-capf
.
.SH FILES
.TP \w'$HOME/.ramdefragrc'u+4
.I $HOME/.ramdefragrc
configuration file for internal use. Do not edit this file!
.
.SH ENVIRONMENT
ramdefrag's behavior is affected by the following environment variables.
.PP
A locale
.BI LC_ foo
is specified by examining the three environment variables
.BR LC_ALL ,
.BR LC_\fIfoo\fP ,
.BR LANG ,
in that order.
The first of these variables that is set specifies the locale.
For example, if
.B LC_ALL
is not set, but
.B LC_MESSAGES
is set to
.BR pt_BR ,
then Brazilian Portuguese may be used for the
.B LC_MESSAGES
locale (if such a translation would exist).
The C locale is used if none of these environment variables are set,
or if the locale catalog is not installed, or if
.B ramdefrag
was not compiled with national language support (\s-1NLS\s0).
.TP
\fBLC_ALL\fP, \fBLC_CTYPE\fP, \fBLANG\fP
These variables specify the
.B LC_CTYPE
locale, which determines the type of characters, e.g., which
characters are whitespace.
.TP
\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP
These variables specify the
.B LC_MESSAGES
locale, which determines the language that
.B ramdefrag
uses for messages.
The default C locale uses American English messages.
.
.SH DIAGNOSTICS
.B ramdefrag
returns 0 on success, and some value greater than 0 if there are any errors.
.
.SH SECURITY
As
.B ramdefrag
uses the new and bleeding-edge
.SM H.O.R.S.T.I.
technology, it does not need to be run with any special privileges.  On the
contrary, using
.B ramdefrag
or any other GUI tool as the superuser is considered \fIvery rude\fP and
usually is a \fIBad Thing\fP\*(Tm.
.
.SH BUGS
Email bug reports and/or feature requests to
.BR <[e-mail]> .
Be sure to include the word \*(lqramdefrag\*(rq somewhere in the
\*(lqSubject:\*(rq field.
.PP
.B ramdefrag
uses \fIprogress bars\fP, which may fall under some obscure software patents, so
using it may bring legal problems if you live in the U.S.A. or some other
medieval country.
.PP
This manpage is only available in English, and may be slightly outdated.
.
.SH COPYRIGHT
Copyright \(co 2004, 2005 knilch <[e-mail]>
.br
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  You may redistribute copies of
.B ramdefrag
under the terms of the GNU General Public License.
For more information about these matters, see the file named COPYING.
.\" Work around problems with some troff -man implementations.
.br