From b475f5d69e6775fa67d1dde6a72c60e1f83bccfd Mon Sep 17 00:00:00 2001
From: psychon <psychon@726aef4b-f618-498e-8847-2d620e286838>
Date: Sat, 14 Jun 2008 16:17:46 +0000
Subject: [PATCH] Make --makeconf more clear

This rephrases one of the questions asked and adds a section to the README that
explains two unclear questions.

This patch is based on a patch from Patrick Matthaei from debian.


git-svn-id: https://znc.svn.sourceforge.net/svnroot/znc/trunk@1093 726aef4b-f618-498e-8847-2d620e286838
---
 README  | 19 +++++++++++++++++++
 znc.cpp |  2 +-
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 8d664ab4..95321d61 100644
--- a/README
+++ b/README
@@ -6,6 +6,7 @@ Table of contents:
 - Optional Requirements
 - Installing ZNC
 - Setting up znc.conf
+- Special config options
 - Using ZNC
 - File Locations
 - ZNC's config file
@@ -54,6 +55,24 @@ for in-place execution.
 If you are using SSL you should do
  znc --makepem
 
+Special config options
+----------------------
+
+When you create your ZNC configuration file via --makeconf, you are asked two
+questions which might not be easy to understand.
+
+> Number of lines to buffer per channel
+How many messages should be buffered for each channel. When you connect to ZNC
+you get a buffer replay for each channel which shows what was said last. This
+option selects the number of lines this replay should consist of. Increasing
+this can greatly increase ZNC's memory usage if you are hosting many users.
+The default value should be fine for most setups.
+
+> Would you like to keep buffers after replay?
+If this is disabled, you get the buffer playback only once and then it is
+deleted. If this is enabled, the buffer is not deleted. This may be useful if
+you regularly use more than one client to connect to ZNC.
+
 Using ZNC
 ---------
 
diff --git a/znc.cpp b/znc.cpp
index 93bd0f2e..51ab539e 100644
--- a/znc.cpp
+++ b/znc.cpp
@@ -684,7 +684,7 @@ bool CZNC::WriteNewConfig(const CString& sConfig) {
 		if (uBufferCount) {
 			vsLines.push_back("\tBuffer     = " + CString(uBufferCount));
 		}
-		if (CUtils::GetBoolInput("Would you like your buffer to be sticky?", false)) {
+		if (CUtils::GetBoolInput("Would you like to keep buffers after replay?", false)) {
 			vsLines.push_back("\tKeepBuffer = true");
 		} else {
 			vsLines.push_back("\tKeepBuffer = false");