Gentoo Archives: gentoo-commits

From: "Christian Faulhammer (fauli)" <fauli@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] emacs r1205 - emacs-daemon
Date: Wed, 31 Dec 2008 11:07:20
Message-Id: E1LHyut-0003P3-Hw@stork.gentoo.org
Author: fauli
Date: 2008-12-31 11:07:09 +0000 (Wed, 31 Dec 2008)
New Revision: 1205

Added:
   emacs-daemon/README
Modified:
   emacs-daemon/ChangeLog
   emacs-daemon/Makefile
Log:
* README: Add little user guide how to use the emacs-daemon script

* Makefile (DISTFILES): Put it into the tarball



Modified: emacs-daemon/ChangeLog
===================================================================
--- emacs-daemon/ChangeLog	2008-12-30 17:05:24 UTC (rev 1204)
+++ emacs-daemon/ChangeLog	2008-12-31 11:07:09 UTC (rev 1205)
@@ -1,3 +1,9 @@
+2008-12-31  Christian Faulhammer  <fauli@g.o>
+
+	* README: Add little user guide how to use the emacs-daemon script
+
+	* Makefile (DISTFILES): Put it into the tarball
+
 2008-12-27  Ulrich Mueller  <ulm@g.o>
 
 	* Version 0.10 released.

Modified: emacs-daemon/Makefile
===================================================================
--- emacs-daemon/Makefile	2008-12-30 17:05:24 UTC (rev 1204)
+++ emacs-daemon/Makefile	2008-12-31 11:07:09 UTC (rev 1205)
@@ -7,7 +7,7 @@
 P = $(PN)-$(PV)
 
 DISTFILES = ChangeLog emacs.rc emacs.conf emacs-wrapper.sh \
-	10emacs-daemon-gentoo.el
+	10emacs-daemon-gentoo.el README
 
 
 .PHONY: all dist clean

Added: emacs-daemon/README
===================================================================
--- emacs-daemon/README	                        (rev 0)
+++ emacs-daemon/README	2008-12-31 11:07:09 UTC (rev 1205)
@@ -0,0 +1,32 @@
+User Guide for Emacs Daemon init script
+=======================================
+
+GNU Emacs 23 supports running as a daemon in the background, to which
+a user can connect through the emacsclient program.  No matter if from
+a terminal session (emacsclient -t) or from a X window (emacsclient
+-c), so this gives maximum flexibility in connection with the
+multi-tty extension also added to Emacs 23.
+
+Every user who wants to connect to an Emacs server must have an own
+instance of the daemonized GNU Emacs.  The init script automatically
+determines the user by its name, so you create a symbolic link (do
+not copy the script!) in your /etc/init.d directory:
+
+	ln -s emacs emacs.<username>
+
+Which should then be added to the boot sequence (and will run under
+the user's privileges)
+
+	rc-update add emacs.<username>
+
+File associations in your desktop system should call $(emacsclient
+-c), to get the greatest benefits of the daemon setup.  When closing a
+session or frame, no contents is lost, just reconnect to your server.
+
+Further customizations can be done through the /etc/conf.d/emacs file,
+which is extensively commented.  Global or per user configuration is
+possible, by naming the configuration file.
+
+Please contact the Gentoo GNU Emacs team directly through
+http://bugs.gentoo.org/ (preferred) or by email (emacs@g.o) if
+you have problems, feature requests or found bugs.