irssi/docs/help/in/log.in
Benjamin Denhartog df5132394f
rephrase documentation to be abstract to any given network
IRSSI is an IRC client and should not advertise nor be beholden to any
particular IRC network. This patch is inspired by both of the following
commits, and aims to remove references to any particular network in the
documentation, in an effort to avoid potential conflict amongst team and
community members:

- a4486c236a
- 1ba48840a1

Based on a (as of this writing) draft blog post [0], and the discussion
that has occurred regarding the blog post, it doesn't appear as if the
IRSSI development team is interested in being transparent about the
reasoning behind its aversion to removing the Freenode network,
specifically related to the comments about "potential legal
consequences". By removing references to any given network in the
documentation, this project moves forward without taking a political
stance, but in a way that avoids recommending any given network to
users.

[0]: https://github.com/irssi/irssi.github.io/pull/79
2021-05-27 09:39:41 -06:00

48 lines
1.5 KiB
Text

%9Syntax:%9
@SYNTAX:log@
%9Parameters:%9
OPEN: Opens a log file.
CLOSE: Closes a log file.
START: Starts logging a log entry.
STOP: Stops logging a log entry.
-noopen: Saves the entry in the configuration, but doesn't actually
start logging.
-autoopen: Automatically opens the log at startup.
-window: Displays the output to the active window, or the window
specified in the targets parameter.
-<server tag>: The server tag the targets must be on.
-targets: Logs the specified nicknames or channels.
-colors: Also log the color codes of the messages.
The filename of the log and the levels to match; if no argument is given,
the list of open logs will be displayed.
%9Description:%9
Opens a log file and stores the messages of the given targets into it; the
log files will be locked so multiple clients cannot log to the same file.
You may use any of the date formats to create a log rotation; we strongly
recommend you to enable autolog if you are interested in keeping logs.
%9Examples:%9
/LOG OPEN -targets mike ~/irclogs/mike.log MSGS
/LOG OPEN -targets #irssi ~/irclogs/irssi-%%Y-%%m-%%d
/LOG CLOSE ~/irclogs/irssi-%%Y-%%m-%%d
/LOG STOP ~/irclogs/irssi-%%Y-%%m-%%d
/LOG START ~/irclogs/irssi-%%Y-%%m-%%d
/SET autolog ON
%9References:%9
https://github.com/irssi/irssi/blob/master/docs/formats.txt
%9See also:%9 SET LOG, WINDOW LOG