[Nym3-commit] r358 - in trunk/nymbaron: Client doc
jr at conuropsis.org
jr at conuropsis.org
Sun Oct 16 14:16:04 CEST 2005
Author: jr
Date: 2005-10-16 14:16:03 +0200 (Sun, 16 Oct 2005)
New Revision: 358
Modified:
trunk/nymbaron/Client/Main.py
trunk/nymbaron/doc/nymbaron.xml
Log:
- Usage strings fixes
- Add ldelete-journal entry in the documentation
Modified: trunk/nymbaron/Client/Main.py
===================================================================
--- trunk/nymbaron/Client/Main.py 2005-10-16 11:07:28 UTC (rev 357)
+++ trunk/nymbaron/Client/Main.py 2005-10-16 12:16:03 UTC (rev 358)
@@ -744,10 +744,10 @@
#TODO indicate the defaults
parser.add_option("-o", "--older", action = "store",
dest = "older", help = "Retrieve only summaries "
- "older than msgid, defaults to oldest_mid "
- "(a special mid oldest than any other). msgid can "
+ "older than OLDER, defaults to oldest_mid "
+ "(a special mid oldest than any other). OLDER can "
"be a mid or a reference syn:N, where N is the "
- "index of the msgid in the synbox, obtained "
+ "index of OLDER in the synbox, obtained "
"by list-syn")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
@@ -763,7 +763,7 @@
provided by the list-syn command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request deletion")
+ "of the account whose emails to delete")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -808,14 +808,14 @@
Process an incoming server command message once it has been
reconstructed.""")
parser.add_option("-i", "--idtag", action = "store",
- dest = "idtag", help = "The idTag contained in the"
+ dest = "idtag", help = "The idTag contained in the "
"enclosing SURB")
parser.add_option("-n", "--nickname", action = "store",
- dest = "nickname", help = "The nickname of the"
+ dest = "nickname", help = "The nickname of the "
"account to use")
parser.add_option("-f", "--file", action = "store",
- dest = "file", help = "The file to read the message"
- " from, or stdin if omitted")
+ dest = "file", help = "The file to read the message "
+ "from, or stdin if omitted")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
if (not options.idtag) and (not options.nickname):
@@ -844,7 +844,7 @@
List the summaries present in the local synbox.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose synopsis to list")
+ "of the account whose synopses to list")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -857,7 +857,7 @@
Output the summaries present in the local synbox.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose synopsis to dump")
+ "of the account whose synopses to dump")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -870,7 +870,7 @@
List the messages present in the local mbox.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account whose mbox to list")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -898,7 +898,7 @@
index provided by the list-journal command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account from which the user resends commands")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -908,15 +908,15 @@
if args[1] == "export":
parser = OptionParser(usage =
"""nymbaron export [options] [ref1 [ref2 [...]]]
- Exports messages present in the local mbox. The references are either
+ Export messages present in the local mbox. The references are either
mids or mbox:N where N is the index provided by the list-mbox
command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account whose emails to export")
parser.add_option("-o", "--output", action = "store",
dest = "output", help = "The file to export the " +
- "message to, stdout if omitted")
+ "messages to, stdout if omitted")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -931,7 +931,7 @@
command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account whose emails to delete locally")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -941,12 +941,12 @@
if args[1] == "ldelete-syn":
parser = OptionParser(usage =
"""nymbaron ldelete-syn [options] [ref1 [ref2 [...]]]
- Delete messages present in the local synbox. The references are either
+ Delete summaries present in the local synbox. The references are either
mids or syn:N where N is the index provided by the list-syn
command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account whose summaries to delete locally")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
@@ -957,11 +957,11 @@
parser = OptionParser(usage =
"""nymbaron ldelete-journal [options] [ref1 [ref2 [...]]]
Delete journal items present in the local journal. The references are
- either sequence number or journal:N where N is the index provided by the
- list-journal command.""")
+ either sequence numbers or journal:N where N is the index provided by
+ the list-journal command.""")
parser.add_option("-n", "--nickname", action = "store",
dest = "nickname", help = "The nickname "
- "of the account whose emails to request")
+ "of the account whose journal items to delete")
(options, args) = parser.parse_args(args[2:])
ui = CLI()
config = Config.Config()
Modified: trunk/nymbaron/doc/nymbaron.xml
===================================================================
--- trunk/nymbaron/doc/nymbaron.xml 2005-10-16 11:07:28 UTC (rev 357)
+++ trunk/nymbaron/doc/nymbaron.xml 2005-10-16 12:16:03 UTC (rev 358)
@@ -82,7 +82,8 @@
</para>
<para>
The message to be sent is taken from a file pointed by the appropriate
- option or from standard input.
+ option or from standard input. The address of the recipient must be passed
+ by option.
</para>
</listitem>
</varlistentry>
@@ -301,7 +302,7 @@
reference ('mbox:N', where N is the index of message in the local mbox).
</para>
<para>
- Note than after a deletion of messages, the index designing messages in
+ Note that after a deletion of messages, the index designing messages in
the local mbox may have changed. Use 'list-mbox' before making further
mbox references ('mbox:N' references).
</para>
@@ -319,7 +320,7 @@
('syn:N', where N is the index of the mid in the synbox).
</para>
<para>
- Note than after a deletion of summaries, the index designing mids in the
+ Note that after a deletion of summaries, the index designing mids in the
synbox may have changed. Use 'list-syn' before making further synbox
references ('syn:N' references).
</para>
@@ -327,6 +328,29 @@
</varlistentry>
<varlistentry>
+ <term><command>ldelete-journal</command></term>
+ <listitem>
+ <para>
+ Delete journal items from the journal of sent commands. The account must
+ be precised by the user. The user gives a list of sequence numbers,
+ either by value or by journal reference ('journal:N', where N is the
+ index of the sequence number in the journal).
+ </para>
+ <para>
+ The user may want to remove items from the journal without waiting for
+ the server to acknoledge them, either because she doesn't want to resend
+ a command or because she knows the server received the command and that
+ the acknowledgement was lost.
+ </para>
+ <para>
+ Note that after a deletion of journal item, the index designing sequence
+ numbers in the journal may have changed. Use 'list-journal' before
+ making further journal references ('journal:N' references).
+ </para>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
<term><command>list-accounts</command></term>
<listitem>
<para>
More information about the Nym3-commit
mailing list