Changeset 440

Timestamp:

Mar 30, 2007 2:49:36 AM (6 years ago)

Author:

dkg

Message:

cereal: starting documentation overhaul as the first steps toward screen 0.4

Location:

trunk/cereal

Files:

• Makefile (modified) (1 diff)
• TODO (modified) (2 diffs)
• debian/changelog (modified) (1 diff)
• docs (added)
• docs/reciprocal-serial-consoles.txt (added)
• fs/usr/share/man/man1/cereal.1 (modified) (1 diff)

trunk/cereal/Makefile

@@ -31 +31 @@
         mkdir -p build/upstream
         ln -s ../.. build/upstream/cereal-$(VERSION)
-        (cd build/upstream && tar czf ../cereal_$(VERSION).tar.gz --exclude=.svn --exclude=*~ cereal-$(VERSION)/{fs,COPYING,Makefile})
+        (cd build/upstream && tar czf ../cereal_$(VERSION).tar.gz --exclude=.svn --exclude=*~ cereal-$(VERSION)/{fs,COPYING,Makefile,docs})
         rm -f build/upstream/cereal-$(VERSION)
 

trunk/cereal/TODO

@@ -5 +5 @@
 - jamie doesn't want to do this.  jamie thinks timestamps are plenty
    "reasonable" as they are.  
-
-figure out what else the post{inst,rm} scripts need to be doing
 
 lock screen session from arbitrary execution
@@ -21 +19 @@
 
 bash completion
+
+create example "how to use cereal" file.

trunk/cereal/debian/changelog

@@ +1 @@
+cereal (0.4-1) unstable; urgency=low
+
+  * added more documentation
+  * NOT FOR RELEASE
+
+ -- Daniel Kahn Gillmor <dkg-debian.org@fifthhorseman.net>  Fri, 30 Mar 2007 02:28:06 -0400
+
 cereal (0.3-3) unstable; urgency=low
 

trunk/cereal/fs/usr/share/man/man1/cereal.1

@@ -7 +7 @@
 .PP
 \fBcereal\fP is the client program to attach to a running cereal session.
-Without arguments, \fBcereal\fP will list the available sessions that the user is
-allowed to access.  Otherwise, the first argument should be the session name to
-attach to.
 .PP
-To detach from a session, detach the screen from the terminal with the screen
-detach key command ("C-a C-d" by default).
+\fBcereal attach foo\fP will attach to (take control of) a cereal session named "foo".
 .PP
-See `man screen' for more info on how to use screen while in the session. 
+\fBcereal follow foo\fP will follow (watch, without being able to
+intervene) a cereal session named "foo".  You can stop following a
+session by sending it a SIGINT (Ctrl+c).
+.PP
+\fBcereal list\fP will list the available sessions that the user is
+allowed to access.  The leading three characters in the list indicate:
+.TP
+\(bu
+whether the session is enabled (+) or not (-)
+.TP
+\(bu
+whether the user can attach to the session (a) or not (-)
+.TP
+\(bu
+whether the user can follow the session (a) or not (-)
+.PP
+To detach from an attached session, use the screen detach key command
+("C-a C-d" by default).
+.PP
+See
+.BR screen (1)
+for more info on how to use screen while in the session. 
 .PP
 The cereal system is outlined at: