logrotate

package: logrotate

title: logrotate(8)

text:
# logrotate(8)

## NAME
logrotate ‐ rotates, compresses, and mails system logs

## SYNOPSIS
logrotate [--force] [--debug] [--state file] [--skip-state-lock] [--verbose] [--log file] [--mail command] config_file [config_file2 ...]

## DESCRIPTION
logrotate is designed to ease administration of systems that generate large numbers of log files. It allows automatic rotation, compression, removal, and mailing of log files. Each log file may be handled daily, weekly, monthly, or when it grows too large.

Normally, logrotate is run as a daily cron job. It will not modify a log more than once in one day unless the criterion for that log is based on the log's size and logrotate is being run more than once each day, or unless the -f or --force option is used.

Any number of config files may be given on the command line. Later config files may override the options given in earlier files, so the order in which the logrotate config files are listed is important. Normally, a single config file which includes any other config files which are needed should be used. See below for more information on how to use the include directive to accomplish this. If a directory is given on the command line, every file in that directory is used as a config file.

If no command line arguments are given, logrotate will print version and copyright information, along with a short usage summary. If any errors occur while rotating logs, logrotate will exit with non-zero status, although the state file will be updated.

## OPTIONS
-f, --force

Tells logrotate to force the rotation, even if it doesn't think this is necessary. Sometimes this is useful after adding new entries to a logrotate config file, or if old log files have been removed by hand, as the new files will be created, and logging will continue correctly.

-d, --debug

Turn on debug mode, which means that no changes are made to the logs and the logrotate state file is not updated. Only debug messages are printed.

-s, --state statefile

Tells logrotate to use an alternate state file. This is useful if logrotate is being run as a different user for various sets of log files. To prevent parallel execution logrotate by default acquires a lock on the state file, if it cannot be acquired logrotate will exit with value 3. The default state file is /var/lib/status. If /dev/null is given as the state file, then logrotate will not try to lock or write the state file.

--skip-state-lock

Do not lock the state file, for example if locking is unsupported or prohibited.

-v, --verbose

Turns on verbose mode, for example to display messages during rotation.

-l, --log file

Tells logrotate to log verbose output into the log_file. The verbose output logged to that file is the same as when running logrotate with -v switch. The log file is overwritten on every logrotate execution.

-m, --mail command

Tells logrotate which command to use when mailing logs. This command should accept the following arguments:

1) the subject of the message given with '-s subject'

2) the recipient.

The command must then read a message on standard input and mail it to the recipient. The default mail command is /bin/mail.

--usage

Prints a short usage message.

-?, --help

Prints help message.

--version

Display version information.

## CONFIGURATION FILE
logrotate reads everything about the log files it should be handling from the series of configuration files specified on the command line. Each configuration file can set global options (local definitions override global ones, and later definitions override earlier ones) and specify logfiles to rotate. Global options do not affect preceding include directives. A simple configuration file looks like this:

```
# sample logrotate configuration file
compress
/var/log/messages {

    rotate 5

    weekly

    postrotate

        /usr/bin/killall -HUP syslogd

    endscript
}
"/var/log/httpd/access.log" /var/log/httpd/error.log {

    rotate 5

    mail recipient@example.org

    size 100k

    sharedscripts

    postrotate

        /usr/bin/killall -HUP httpd

    endscript
}
/var/log/news/* {

    monthly

    rotate 2

    olddir /var/log/news/old

    missingok

    sharedscripts

    postrotate

        kill -HUP $(cat /var/run/inn.pid)

    endscript

    nocompress
}
~/log/*.log {}
```

The first few lines set global options; in the example, logs are compressed after they are rotated. Note that comments may appear anywhere in the config file as long as the first non-whitespace character on the line is a #.

Values are separated from directives by whitespace and/or an optional =. Numbers must be specified in a format understood by strtoul(3).

The next section of the config file defines how to handle the log file /var/log/messages. The log will go through five weekly rotations before being removed. After the log file has been rotated (but before the old version of the log has been compressed), the command /usr/bin/killall -HUP syslogd will be executed.

The next section defines the parameters for both /var/log/httpd/access.log and /var/log/httpd/error.log. Each is rotated whenever it grows over 100 kilobytes in size, and the old logs files are mailed (uncompressed) to recipient@example.org after going through 5 rotations, rather than being removed. The sharedscripts means that the postrotate script will only be run once (after the old logs have been compressed), not once for each log which is rotated. Note that log file names may be enclosed in quotes (and that quotes are required if the name contains spaces). Normal shell quoting rules apply, with ', ", and \ characters supported.

The next section defines the parameters for all of the files in /var/log/news. Each file is rotated on a monthly basis.

The last section uses tilde expansion to rotate log files in the home directory of the current user. This is only available, if your glob library supports tilde expansion. GNU glob does support this.

Please use wildcards with caution. If you specify *, logrotate will rotate all files, including previously rotated ones. A way around this is to use the olddir directive or a more exact wildcard (such as *.log).

Please note, by default when using systemd(1), the option ProtectSystem=full is set in the logrotate.service file. This prevents logrotate from modifying logs in /etc and /usr.

Here is more information on the directives which may be included in a logrotate configuration file:

## CONFIGURATION FILE DIRECTIVES
These directives may be included in a logrotate configuration file:

### Rotation
rotate count

Log files are rotated count times before being removed or mailed to the address specified in a mail directive. If count is 0, old versions are removed rather than rotated. If count is -1, old logs are not removed at all, except they are affected by maxage (use with caution, may waste performance and disk space). Default is 0.

olddir directory

Logs are moved into directory for rotation. The directory must be on the same physical device as the log file being rotated, unless copy, copytruncate or renamecopy option is used. The directory is assumed to be relative to the directory holding the log file unless an absolute path name is specified. When this option is used all old versions of the log end up in directory. This option may be overridden by the noolddir option.

noolddir

Logs are rotated in the directory they normally reside in (this overrides the olddir option).

su user group

Rotate log files set under this user and group instead of using default user/group (usually root). user specifies the user used for rotation and group specifies the group used for rotation (see the section USER AND GROUP for details). If the user/group you specify here does not have sufficient privilege to make files with the ownership you've specified in a create directive, it will cause an error. If logrotate runs with root privileges, it is recommended to use the su directive to rotate files in directories that are directly or indirectly in control of non-privileged users.

### Frequency
hourly

Log files are rotated every hour. Note that usually logrotate is configured to be run by cron daily (or by logrotate.timer when using systemd(1)). You have to change this configuration and run logrotate hourly to be able to really rotate logs hourly.

daily

Log files are rotated every day.

weekly [weekday]

Log files are rotated once each weekday, or if the date is advanced by at least 7 days since the last rotation (while ignoring the exact time). The weekday interpretation is following: 0 means Sunday, 1 means Monday, ..., 6 means Saturday; the special value 7 means each 7 days, irrespectively of weekday. Defaults to 0 if the weekday argument is omitted.

monthly

Log files are rotated the first time logrotate is run in a month (this is normally on the first day of the month).

yearly

Log files are rotated if the current year is not the same as the last rotation.

size size

Log files are rotated only if they grow bigger than size bytes. If size is followed by k, the size is assumed to be in kilobytes. If M is used, the size is in megabytes, and if G is used, the size is in gigabytes. So size 100, size 100k, size 100M and size 100G are all valid. This option is mutually exclusive with the time interval options, and it causes log files to be rotated without regard for the last rotation time, if specified after the time criteria (the last specified option takes the precedence).

### File selection
missingok

If the log file is missing, go on to the next one without issuing an error message. See also nomissingok.

nomissingok

If a log file does not exist, issue an error. This is the default.

ifempty

Rotate the log file even if it is empty, overriding the notifempty option (ifempty is the default).

notifempty

Do not rotate the log if it is empty (this overrides the ifempty option).

minage count

Do not rotate logs which are less than <count> days old.

maxage count

Remove rotated logs older than <count> days. The age is only checked if the logfile is to be rotated. rotate -1 does not hinder removal. The files are mailed to the configured address if maillast and mail are configured.

minsize size

Log files are rotated when they grow bigger than size bytes, but not before the additionally specified time interval (daily, weekly, monthly, or yearly). The related size option is similar except that it is mutually exclusive with the time interval options, and it causes log files to be rotated without regard for the last rotation time, if specified after the time criteria (the last specified option takes the precedence). When minsize is used, both the size and timestamp of a log file are considered.

maxsize size

Log files are rotated when they grow bigger than size bytes even before the additionally specified time interval (daily, weekly, monthly, or yearly). The related size option is similar except that it is mutually exclusive with the time interval options, and it causes log files to be rotated without regard for the last rotation time, if specified after the time criteria (the last specified option takes the precedence). When maxsize is used, both the size and timestamp of a log file are considered.

tabooext [+] list

The current taboo extension list is changed (see the include directive for information on the taboo extensions). If a + precedes the list of extensions, the current taboo extension list is augmented, otherwise it is replaced. At startup, the taboo extension list ,v, .cfsaved, .disabled, .dpkg-bak, .dpkg-del, .dpkg-dist, .dpkg-new, .dpkg-old, .rhn-cfg-tmp-*, .rpmnew, .rpmorig, .rpmsave, .swp, .ucf-dist, .ucf-new, .ucf-old, ~

taboopat [+] list

The current taboo glob pattern list is changed (see the include directive for information on the taboo extensions and patterns). If a + precedes the list of patterns, the current taboo pattern list is augmented, otherwise it is replaced. At startup, the taboo pattern list is empty.

### Files and Folders
create mode owner group, create owner group

Immediately after rotation (before the postrotate script is run) the log file is created (with the same name as the log file just rotated). mode specifies the mode for the log file in octal (the same as chmod(2)), owner specifies the user who will own the log file, and group specifies the group the log file will belong to (see the section USER AND GROUP for details). Any of the log file attributes may be omitted, in which case those attributes for the new file will use the same values as the original log file for the omitted attributes. This option can be disabled using the nocreate option.

nocreate

New log files are not created (this overrides the create option).

createolddir mode owner group

If the directory specified by olddir directive does not exist, it is created. mode specifies the mode for the olddir directory in octal (the same as chmod(2)), owner specifies the user who will own the olddir directory, and group specifies the group the olddir directory will belong to (see the section USER AND GROUP for details). This option can be disabled using the nocreateolddir option.

nocreateolddir

olddir directory is not created by logrotate when it does not exist.

copy

Make a copy of the log file, but don't change the original at all. This option can be used, for instance, to make a snapshot of the current log file, or when some other utility needs to truncate or parse the file. When this option is used, the create option will have no effect, as the old log file stays in place. The copy option allows storing rotated log files on the different devices using olddir directive.

nocopy

Do not copy the original log file and leave it in place. (this overrides the copy option).

copytruncate

Truncate the original log file to zero size in place after creating a copy, instead of moving the old log file and optionally creating a new one. It can be used when some program cannot be told to close its logfile and thus might continue writing (appending) to the previous log file forever. Note that there is a very small time slice between copying the file and truncating it, so some logging data might be lost. When this option is used, the create option will have no effect, as the old log file stays in place. The copytruncate option allows storing rotated log files on the different devices using olddir directive. The copytruncate option implies norenamecopy.

nocopytruncate

Do not truncate the original log file in place after creating a copy (this overrides the copytruncate option).

renamecopy

Log file is renamed to temporary filename in the same directory by adding ".tmp" extension to it. After that, postrotate script is run and log file is copied from temporary filename to final filename. In the end, temporary filename is removed. The renamecopy option allows storing rotated log files on the different devices using olddir directive. The renamecopy option implies nocopytruncate.

norenamecopy

Do not rename and copy the original log file (this overrides the renamecopy option).

shred

Delete log files using shred -u instead of unlink(). This should ensure that logs are not readable after their scheduled deletion; this is off by default. See also noshred.

noshred

Do not use shred when deleting old log files. See also shred.

shredcycles count

Asks GNU shred(1) to overwrite log files count times before deletion. Without this option, shred's default will be used.

allowhardlink

Rotate files with multiple hard links; this is off by default. The target file might get emptied, e.g. with shred or copytruncate. Use with caution, especially when the log files are rotated as root.

noallowhardlink

Do not rotate files with multiple hard links. See also allowhardlink.

### Compression
compress

Old versions of log files are compressed with xz(1) by default. See also nocompress.

nocompress

Old versions of log files are not compressed. See also compress.

compresscmd

Specifies which command to use to compress log files. The default is xz(1). See also compress.

uncompresscmd

Specifies which command to use to uncompress log files. The default is unxz(1).

compressext

Specifies which extension to use on compressed logfiles, if compression is enabled. The default follows that of the configured compression command.

compressoptions

Command line options may be passed to the compression program, if one is in use. The default, for xz(1), is "-6" (biased towards high compression at the expense of speed). If you use a different compression command, you may need to change the compressoptions to match.

delaycompress

Postpone compression of the previous log file to the next rotation cycle. This only has effect when used in combination with compress. It can be used when some program cannot be told to close its logfile and thus might continue writing to the previous log file for some time.

nodelaycompress

Do not postpone compression of the previous log file to the next rotation cycle (this overrides the delaycompress option).

### Filenames
extension ext

Log files with ext extension can keep it after the rotation. If compression is used, the compression extension (normally .xz) appears after ext. For example you have a logfile named mylog.foo and want to rotate it to mylog.1.foo.xz instead of mylog.foo.1.xz.

addextension ext

Log files are given the final extension ext after rotation. If the original file already ends with ext, the extension is not duplicated, but merely moved to the end, that is both filename and filenameext would get rotated to filename.1ext. If compression is used, the compression extension (normally .xz) appears after ext.

start count

This is the number to use as the base for rotation. For example, if you specify 0, the logs will be created with a .0 extension as they are rotated from the original log files. If you specify 9, log files will be created with a .9, skipping 0–8. Files will still be rotated the number of times specified with the rotate directive.

dateext

Archive old versions of log files adding a date extension like YYYYMMDD instead of simply adding a number. The extension may be configured using the dateformat and dateyesterday options.

nodateext

Do not archive old versions of log files with date extension (this overrides the dateext option).

dateformat format_string

Specify the extension for dateext using the notation similar to strftime(3) function. Only %Y %m %d %H %M %S %V and %s specifiers are allowed. The default value is -%Y%m%d except hourly, which uses -%Y%m%d%H as default value. Note that also the character separating log name from the extension is part of the dateformat string. The system clock must be set past Sep 9th 2001 for %s to work correctly. Note that the datestamps generated by this format must be lexically sortable (that is first the year, then the month then the day. For example 2001/12/01 is ok, but 01/12/2001 is not, since 01/11/2002 would sort lower while it is later). This is because when using the rotate option, logrotate sorts all rotated filenames to find out which logfiles are older and should be removed.

dateyesterday

Use yesterday's instead of today's date to create the dateext extension, so that the rotated log file has a date in its name that is the same as the timestamps within it.

datehourago

Use hour ago instead of current date to create the dateext extension, so that the rotated log file has a hour in its name that is the same as the timestamps within it. Useful with rotate hourly.

### Mail
mail address

When a log is rotated out of existence, it is mailed to address. If no mail should be generated by a particular log, the nomail directive may be used.

nomail

Do not mail old log files to any address.

mailfirst

When using the mail command, mail the just-rotated file, instead of the about-to-expire file.

maillast

When using the mail command, mail the about-to-expire file, instead of the just-rotated file (this is the default).

### Additional config files
include file_or_directory

Reads the file given as an argument as if it was included inline where the include directive appears. If a directory is given, most of the files in that directory are read in alphabetic order before processing of the including file continues. The only files which are ignored are files which are not regular files (such as directories and named pipes) and files whose names end with one of the taboo extensions or patterns, as specified by the tabooext or taboopat directives, respectively. The given path may start with ~/ to make it relative to the home directory of the executing user. For security reasons configuration files must not be group-writable nor world-writable.

### Scripts
sharedscripts

Normally, prerotate and postrotate scripts are run for each log which is rotated and the absolute path to the log file is passed as first argument to the script. That means a single script may be run multiple times for log file entries which match multiple files (such as the /var/log/news/* example). If sharedscripts is specified, the scripts are only run once, no matter how many logs match the wildcarded pattern, and whole pattern is passed to them. However, if none of the logs in the pattern require rotating, the scripts will not be run at all. If the scripts exit with error (or any log fails to rotate), the remaining actions will not be executed for any logs. This option overrides the nosharedscripts option.

nosharedscripts

Run prerotate and postrotate scripts for every log file which is rotated (this is the default, and overrides the sharedscripts option). The absolute path to the log file is passed as first argument to the script. The absolute path to the final rotated log file is passed as the second argument to the postrotate script. If the scripts exit with error, the remaining actions will not be executed for the affected log only.

firstaction

script

endscript

The script is executed once before all log files that match the wildcarded pattern are rotated, before the prerotate script is run and only if at least one log will actually be rotated. These directives may only appear inside a log file definition. The whole pattern is passed to the script as its first argument. If the script exits with an error, no further processing is done. See also lastaction and the SCRIPTS section.

lastaction

script

endscript

The script is executed once after all log files that match the wildcarded pattern are rotated, after the postrotate script is run and only if at least one log is rotated. These directives may only appear inside a log file definition. The whole pattern is passed to the script as its first argument. If the script exits with an error, just an error message is shown (as this is the last action). See also firstaction and the SCRIPTS section.

prerotate

script

endscript

The script is executed before the log file is rotated and only if the log will actually be rotated. These directives may only appear inside a log file definition. Normally, the absolute path to the log file is passed as the first argument to the script. If sharedscripts is specified, the whole pattern is passed to the script. See also postrotate and the SCRIPTS section. See sharedscripts and nosharedscripts for error handling.

postrotate

script

endscript

The script is executed after the log file is rotated. These directives may only appear inside a log file definition. Normally, the absolute path to the log file is passed as the first argument to the script and the absolute path to the final rotated log file is passed as the second argument to the script. If sharedscripts is specified, the whole pattern is passed as the first argument to the script, and the second argument is omitted. See also prerotate and the SCRIPTS section. See sharedscripts and nosharedscripts for error handling.

preremove

script

endscript

The script is executed once just before removal of a log file. logrotate will pass the name of file which is soon to be removed as the first argument to the script. See also firstaction and the SCRIPTS section.

## SCRIPTS
The lines between the starting keyword (e.g. prerotate) and endscript (both of which must appear on lines by themselves) are executed (using /bin/sh). The script inherits some traits from the logrotate process, including stderr, stdout, the current directory, the environment, and the umask. Scripts are run as the invoking user and group, irrespective of any su directive. If the --log flag was specified, file descriptor 3 is the log file. The current working directory is unspecified.

## USER AND GROUP
User and group identifiers are resolved first by trying the textual representation and, in case it fails, afterwards by the numeric value.

## FILES
/var/lib/status

Default state file.

/etc/logrotate.conf

Configuration options.

## SEE ALSO
chmod(2), unxz(1), xz(1), mail(1), shred(1), strftime(3), strtoul(3), <https://github.com/logrotate/logrotate>

## AUTHORS

```
Erik Troan, Preston Brown, Jan Kaluza.
<https://github.com/logrotate/logrotate>
```


logtail

package: logtail

title: logtail(8)

text:
# logtail(8)

## NAME
logtail - print log file lines that have not been read

## SYNOPSIS
logtail [-t] -flogfile [-ooffsetfile]

## DESCRIPTION
logtail reads a specified file (usually a log file) and writes to the standard output that part of it which has not been read by previous runs of logtail. It prints the appropriate number of bytes from the end of logfile, assuming that all changes that are made to it are to add new characters to it.

logfile must be a plain file. A symlink is not allowed.

logtail stores the information about how much of it has already been read in a separate file called offsetfile. offsetfile can be omitted. If omitted, the file named logfile.offset in the same directory which contains logfile is used by default.

If offsetfile is not empty, the inode of logfile is checked. If the inode is changed, logtail simply prints the entire file. If the inode is not changed but logfile is shorter than it was at the last run of logtail, it writes a warning message to the standard output.

## OPTIONS
-f

logfile to be read after offset

-o

offsetfile stores offset of previous run

-t

test mode - do not change offset in offsetfile

## RETURN VALUES
0

successful

65

cannot get the size of logfile

66

logfile does not exist, is not a plain file, or is not readable

73

cannot write offsetfile

## AUTHOR
The original logtail was written in C by Craig H. Rowland <crowland@psionic.com>. This version of logtail is a Perl reimplementation by Paul Slootman <paul@debian.org>. Enhanced by the Debian Logcheck Team <logcheck-devel@lists.alioth.debian.org>.

This manual was written by Oohara Yuuma <oohara@libra.interq.or.jp>.

## SEE ALSO
logcheck(8)


title: logtail2(8)

text:
# logtail2(8)

## NAME
logtail2 - print log file lines that have not been read

## SYNOPSIS
logtail2 [-t] -flogfile [-ooffsetfile]

## DESCRIPTION
logtail2 reads a specified file (usually a log file) and writes to the standard output that part of it which has not been read by previous runs of logtail2. It prints the appropriate number of bytes from the end of logfile, assuming that all changes that are made to it are to add new characters to it.

logfile must be a plain file. A symlink is not allowed.

logtail2 stores the information about how much of it has already been read in a separate file called offsetfile. offsetfile can be omitted. If omitted, the file named logfile.offset in the same directory which contains logfile is used by default.

If offsetfile is not empty, the inode of logfile is checked. If the inode is changed, logtail2 uses the heuristics stored in /usr/share/logtail/detectrotate/ to find a file that might be the rotated logfile and prints it starting with the stored offset. It then proceeds to simply print the entire new file and generates a new offsetfile. If the inode is not changed but logfile is shorter than it was at the last run of logtail2, it writes a warning message to the standard output.

## OPTIONS
-f

logfile to be read after offset

-o

offsetfile stores offset of previous run

-t

test mode - do not change offset in offsetfile

## RETURN VALUES
0

successful

65

cannot get the size of logfile

66

general file or directory access issue

73

cannot write offsetfile

## AUTHOR
The original logtail was written in C by Craig H. Rowland <crowland@psionic.com>. This version of logtail is a modification of Paul Slootman's re-implementation in perl. enhanced by the Debian Logcheck Team <logcheck-devel@lists.alioth.debian.org>.

This manual was written by Oohara Yuuma <oohara@libra.interq.or.jp> and enhanced by the Debian Logcheck Team <logcheck-devel@lists.alioth.debian.org>..

## SEE ALSO
logcheck(8)


logwatch

package: logwatch

title: logwatch(8)

summary: system log analyzer and reporter

text:
# logwatch(8)

## NAME
logwatch - system log analyzer and reporter

## SYNOPSIS
logwatch [--detail level ] [--logfile log-file-group ] [--service service-name ] [--mailto address ] [--archives] [--range range ] [--debug level ] [--filename file-name ] [--logdir directory ] [--hostname hostname ] [--hostformat host based options ] [--output output-type ] [--format report format ] [--encode encoding to use ] [--numeric] [--version] [--help|--usage]

## DESCRIPTION
Logwatch is a customizable, pluggable log-monitoring system. It will go through your logs for a given period of time and make a report in the areas that you wish with the detail that you wish. Logwatch is being used for Linux and many types of UNIX.

## OPTIONS
--detail level

This is the detail level of the report. level can be a positive integer, or high, med, low, which correspond to the integers 10, 5, and 0, repectively.

--logfile log-file-group

This will force Logwatch to process only the set of logfiles defined by log-file-group (i.e. messages, xferlog, ...). Logwatch will therefore process all services that use those logfiles. This option can be specified more than once to specify multiple logfile-groups.

--service service-name

This will force Logwatch to process only the service specified in service-name (i.e. login, pam, identd, ...). Logwatch will therefore also process any log-file-groups necessary to process these services. This option can be specified more than once to specify multiple services to process. A useful service-name is All which will process all services (and logfile-groups) for which you have filters installed.

--mailto address

Mail the results to the email address or user specified in address. This option overrides the --print option.

--range range

You can specify a date-range to process. Common ranges are Yesterday, Today, All, and Help. Additional options are listed when invoked with the Help parameter.

--archives

Each log-file-group has basic logfiles (i.e. /var/log/messages) as well as archives (i.e. /var/log/messages.? or /var/log/messages.?.gz). When used with "--range all", this option will make Logwatch search through the archives in addition to the regular logfiles. For other values of --range, Logwatch will search the appropriate archived logs.

--debug level

For debugging purposes. level can range from 0 to 100. This will really clutter up your output. You probably don't want to use this.

--filename file-name

Save the output to file-name instead of displaying or mailing it.

--logdir directory

Look in directory for log subdirectories or log files instead of the default directory.

--hostname hostname

Use hostname for the reports instead of this system's hostname. In addition, if HostLimit is set in the logwatch.conf configuration file (see MORE INFORMATION, below), then only logs from this hostname will be processed (where appropriate).

--numeric

Inhibits additional name lookups, displaying IP addresses numerically.

--usage

Displays usage information

--help

same as --usage.

## FILES
/usr/share/logwatch/

This directory contains all the perl executables and configuration files shipped with the logwatch distribution.

/etc/logwatch

This directory contains local configuration files that override the default configuration. See MORE INFORMATION below for more information.

## EXAMPLES
logwatch --service ftpd-xferlog --range all --detail high --print --archives

This will print out all FTP transfers that are stored in all current and archived xferlogs.

logwatch --service pam_pwdb --range yesterday --detail high --print This will print out login information for the previous day...

## MORE INFORMATION
The directory /usr/share/doc/logwatch-* contains several files with additional documentation:

HOWTO-Customize-LogWatch

Documents the directory structure of Logwatch configuration and executable files, and describes how to customize Logwatch by overriding these default files.

LICENSE Describes the License under which Logwatch is distributed. Additional clauses may be specified in individual files.

README Describes how to install, where to find it, mailing lists, and other useful information.

## AUTHOR
Kirk Bauer <kirk@kaybee.org>

http://www.kaybee.org/~kirk

ftp://ftp.kaybee.org/pub/redhat/RPMS


losetup

package: losetup

title: losetup(8)

summary: set up and control loop devices

text:
# losetup(8)

## NAME
losetup - set up and control loop devices

## SYNOPSIS
Get info:

losetup [loopdev]

losetup -l [-a]

losetup -j file [-o offset]

Detach a loop device:

losetup -d loopdev ...

Detach all associated loop devices:

losetup -D

Set up a loop device:

losetup [-o offset] [--sizelimit size] [--sector-size size] [-Pr] [--show] -f|loopdev file

Resize a loop device:

losetup -c loopdev

## DESCRIPTION
losetup is used to associate loop devices with regular files or block devices, to detach loop devices, and to query the status of a loop device. If only the loopdev argument is given, the status of the corresponding loop device is shown. If no option is given, all loop devices are shown.

Note that the old output format (i.e., losetup -a) with comma-delimited strings is deprecated in favour of the --list output format.

It’s possible to create more independent loop devices for the same backing file. This setup may be dangerous, can cause data loss, corruption and overwrites. Use --nooverlap with --find during setup to avoid this problem.

The loop device setup is not an atomic operation when used with --find, and losetup does not protect this operation by any lock. The number of attempts is internally restricted to a maximum of 16. It is recommended to use for example flock(1) to avoid a collision in heavily parallel use cases.

## OPTIONS
The size and offset arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.

-a, --all

Show the status of all loop devices. Note that not all information is accessible for non-root users. See also --list. The old output format (as printed without --list) is deprecated.

-d, --detach loopdev...

Detach the file or device associated with the specified loop device(s). Note that since Linux v3.7 kernel uses "lazy device destruction". The detach operation does not return EBUSY error anymore if device is actively used by system, but it is marked by autoclear flag and destroyed later.

-D, --detach-all

Detach all associated loop devices.

-f, --find [file]

Find the first unused loop device. If a file argument is present, use the found device as loop device. Otherwise, just print its name.

--show

Display the name of the assigned loop device if the -f option and a file argument are present.

-L, --nooverlap

Check for conflicts between loop devices to avoid situation when the same backing file is shared between more loop devices. If the file is already used by another device then re-use the device rather than a new one. The option makes sense only with --find.

-j, --associated file [-o offset]

Show the status of all loop devices associated with the given file.

-o, --offset offset

The data start is moved offset bytes into the specified file or device. The offset may be followed by the multiplicative suffixes; see above.

--sizelimit size

The data end is set to no more than size bytes after the data start. The size may be followed by the multiplicative suffixes; see above.

-b, --sector-size size

Set the logical sector size of the loop device in bytes (since Linux 4.14). The option may be used when creating a new loop device as well as a stand-alone command to modify sector size of the already existing loop device.

-c, --set-capacity loopdev

Force the loop driver to reread the size of the file associated with the specified loop device.

-P, --partscan

Force the kernel to scan the partition table on a newly created loop device. Note that the partition table parsing depends on sector sizes. The default is sector size is 512 bytes, otherwise you need to use the option --sector-size together with --partscan.

-r, --read-only

Set up a read-only loop device.

--direct-io[=on|off]

Enable or disable direct I/O for the backing file. The optional argument can be either on or off. If the optional argument is omitted, it defaults to on.

-v, --verbose

Verbose mode.

-l, --list

If a loop device or the -a option is specified, print the default columns for either the specified loop device or all loop devices; the default is to print info about all devices. See also --output, --noheadings, --raw, and --json.

-O, --output column[,column]...

Specify the columns that are to be printed for the --list output. Use --help to get a list of all supported columns.

--output-all

Output all available columns.

-n, --noheadings

Don’t print headings for --list output format.

--raw

Use the raw --list output format.

-J, --json

Use JSON format for --list output.

## ENCRYPTION
Cryptoloop is no longer supported in favor of dm-crypt. For more details see cryptsetup(8).

## EXIT STATUS
losetup returns 0 on success, nonzero on failure. When losetup displays the status of a loop device, it returns 1 if the device is not configured and 2 if an error occurred which prevented determining the status of the device.

## NOTES
Since version 2.37 losetup uses LOOP_CONFIGURE ioctl to setup a new loop device by one ioctl call. The old versions use LOOP_SET_FD and LOOP_SET_STATUS64 ioctls to do the same.

## ENVIRONMENT
LOOPDEV_DEBUG=all

enables debug output.

## FILES
/dev/loop[0..N]

loop block devices

/dev/loop-control

loop control device

## EXAMPLE
The following commands can be used as an example of using the loop device.

```
# dd if=/dev/zero of=~/file.img bs=1024k count=10
# losetup --find --show ~/file.img
/dev/loop0
# mkfs -t ext2 /dev/loop0
# mount /dev/loop0 /mnt
...
# umount /dev/loop0
# losetup --detach /dev/loop0
```

## AUTHORS
Karel Zak <kzak@redhat.com>, based on the original version from Theodore Ts’o <tytso@athena.mit.edu>.

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The losetup command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.


lsblk

package: lsblk

title: lsblk(8)

summary: list block devices

text:
# lsblk(8)

## NAME
lsblk - list block devices

## SYNOPSIS
lsblk [options] [device...]

## DESCRIPTION
lsblk lists information about all available or the specified block devices. The lsblk command reads the sysfs filesystem and udev db to gather information. If the udev db is not available or lsblk is compiled without udev support, then it tries to read LABELs, UUIDs and filesystem types from the block device. In this case root permissions are necessary.

By default, the command prints all block devices (except RAM disks) in a tree-like format. The same device can be repeated in the tree if it relates to other devices. The --merge option is recommended for more complicated setups to gather groups of devices and describe complex N:M relationships.

The default output, as well as the default output from options like --fs and --topology, is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using --output columns-list and --list in environments where a stable output is required.

Use lsblk --help to get a list of all available columns.

Note that lsblk might be executed in time when udev does not have all information about recently added or modified devices yet. In this case it is recommended to use udevadm settle before lsblk to synchronize with udev.

The relationship between block devices and filesystems is not always one-to-one. The filesystem may use more block devices, or the same filesystem may be accessible by more paths. This is the reason why lsblk provides MOUNTPOINT and MOUNTPOINTS (pl.) columns. The column MOUNTPOINT displays only one mount point (usually the last mounted instance of the filesystem), and the column MOUNTPOINTS displays by multi-line cell all mount points associated with the device.

## OPTIONS
-A, --noempty

Don’t print empty devices.

-a, --all

Disable all built-in filters and list all empty devices and RAM disk devices too.

-b, --bytes

Print the sizes in bytes rather than in a human-readable format. By default, the unit, sizes are expressed in, is byte, and unit prefixes are in power of 2^10 (1024). Abbreviations of symbols are exhibited truncated in order to reach a better readability, by exhibiting alone the first letter of them; examples: "1 KiB" and "1 MiB" are respectively exhibited as "1 K" and "1 M", then omitting on purpose the mention "iB", which is part of these abbreviations.

-D, --discard

Print information about the discarding capabilities (TRIM, UNMAP) for each device.

-d, --nodeps

Do not print holder devices or slaves. For example, lsblk --nodeps /dev/sda prints information about the sda device only.

-E, --dedup column

Use column as a de-duplication key to de-duplicate output tree. If the key is not available for the device, or the device is a partition and parental whole-disk device provides the same key than the device is always printed. The usual use case is to de-duplicate output on system multi-path devices, for example by -E WWN.

-e, --exclude list

Exclude the devices specified by the comma-separated list of major device numbers. Note that RAM disks (major=1) are excluded by default if --all is not specified. The filter is applied to the top-level devices only. This may be confusing for --list output format where hierarchy of the devices is not obvious.

-f, --fs

Output info about filesystems. This option is equivalent to -o NAME,FSTYPE,FSVER,LABEL,UUID,FSAVAIL,FSUSE%,MOUNTPOINTS. The authoritative information about filesystems and raids is provided by the blkid(8) command.

-I, --include list

Include devices specified by the comma-separated list of major device numbers. The filter is applied to the top-level devices only. This may be confusing for --list output format where hierarchy of the devices is not obvious.

-i, --ascii

Use ASCII characters for tree formatting.

-J, --json

Use JSON output format. It’s strongly recommended to use --output and also --tree if necessary.

-l, --list

Produce output in the form of a list. The output does not provide information about relationships between devices and since version 2.34 every device is printed only once if --pairs or --raw not specified (the parsable outputs are maintained in backwardly compatible way).

-M, --merge

Group parents of sub-trees to provide more readable output for RAIDs and Multi-path devices. The tree-like output is required.

-m, --perms

Output info about device owner, group and mode. This option is equivalent to -o NAME,SIZE,OWNER,GROUP,MODE.

-N, --nvme

Output info about NVMe devices only.

-v, --virtio

Output info about virtio devices only.

-n, --noheadings

Do not print a header line.

-o, --output list

Specify which output columns to print. Use --help to get a list of all supported columns. The columns may affect tree-like output. The default is to use tree for the column 'NAME' (see also --tree). The default list of columns may be extended if list is specified in the format +list (e.g., lsblk -o +UUID).

-O, --output-all

Output all available columns.

-P, --pairs

Produce output in the form of key="value" pairs. The output lines are still ordered by dependencies. All potentially unsafe value characters are hex-escaped (\x<code>). See also option --shell.

-p, --paths

Print full device paths.

-r, --raw

Produce output in raw format. The output lines are still ordered by dependencies. All potentially unsafe characters are hex-escaped (\x<code>) in the NAME, KNAME, LABEL, PARTLABEL and MOUNTPOINT columns.

-S, --scsi

Output info about SCSI devices only. All partitions, slaves and holder devices are ignored.

-s, --inverse

Print dependencies in inverse order. If the --list output is requested then the lines are still ordered by dependencies.

-T, --tree[=column]

Force tree-like output format. If column is specified, then a tree is printed in the column. The default is NAME column.

-t, --topology

Output info about block-device topology. This option is equivalent to -o NAME,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,RA,WSAME.

-h, --help

Display help text and exit.

-V, --version

Print version and exit.

-w, --width number

Specifies output width as a number of characters. The default is the number of the terminal columns, and if not executed on a terminal, then output width is not restricted at all by default. This option also forces lsblk to assume that terminal control characters and unsafe characters are not allowed. The expected use-case is for example when lsblk is used by the watch(1) command.

-x, --sort column

Sort output lines by column. This option enables --list output format by default. It is possible to use the option --tree to force tree-like output and than the tree branches are sorted by the column.

-y, --shell

The column name will be modified to contain only characters allowed for shell variable identifiers, for example, MIN_IO and FSUSE_PCT instead of MIN-IO and FSUSE%. This is usable, for example, with --pairs. Note that this feature has been automatically enabled for --pairs in version 2.37, but due to compatibility issues, now it’s necessary to request this behavior by --shell.

-z, --zoned

Print the zone related information for each device.

--sysroot directory

Gather data for a Linux instance other than the instance from which the lsblk command is issued. The specified directory is the system root of the Linux instance to be inspected. The real device nodes in the target directory can be replaced by text files with udev attributes.

## EXIT STATUS
0

success

1

failure

32

none of specified devices found

64

some specified devices found, some not found

## ENVIRONMENT
LSBLK_DEBUG=all

enables lsblk debug output.

LIBBLKID_DEBUG=all

enables libblkid debug output.

LIBMOUNT_DEBUG=all

enables libmount debug output.

LIBSMARTCOLS_DEBUG=all

enables libsmartcols debug output.

LIBSMARTCOLS_DEBUG_PADDING=on

use visible padding characters.

## NOTES
For partitions, some information (e.g., queue attributes) is inherited from the parent device.

The lsblk command needs to be able to look up each block device by major:minor numbers, which is done by using /sys/dev/block. This sysfs block directory appeared in kernel 2.6.27 (October 2008). In case of problems with a new enough kernel, check that CONFIG_SYSFS was enabled at the time of the kernel build.

## AUTHORS
Milan Broz <gmazyland@gmail.com>, Karel Zak <kzak@redhat.com>

## SEE ALSO
ls(1), blkid(8), findmnt(8)

## REPORTING BUGS
For bug reports, use the issue tracker at <https://github.com/util-linux/util-linux/issues>.

## AVAILABILITY
The lsblk command is part of the util-linux package which can be downloaded from Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.