1SM(1) InterNetNews Documentation SM(1)
2
6 sm - Command-line interface to the INN storage manager
7
9 sm [-cdHiqRrSs] [token ...]
10
12 The INN storage manager is the subsystem that stores and keeps track of
13 all of the articles and what storage backend they're in. All stored
14 articles are assigned a storage API token. sm is a command-line
15 interface to that storage manager, primarily used to retrieve articles
16 by those tokens but also to perform other operations on the storage
17 subsystem.
18 token is the token of an article (the same thing that's returned by
20 grephistory or stored in the history file). It looks something like:
21 @0502000005A4000000010000000000000000@
23 Any number of tokens can be given on the command-line for any function
25 other than -s. If none are, sm normally reads tokens from standard
26 input, one per line. The default operation is to retrieve and write to
27 standard output the corresponding article for each token given.
28 If -s is given, sm instead stores the article given on standard input
30 (in native format, not wire format) using the standard rules of the
31 storage subsystem. If the article is stored successfully, the token of
32 the article is printed to standard output. Please note that this does
33 not make any attempt to write a history entry or any overview data, and
34 is therefore only useful under very specific circumstances.
35
37 -c Show a clear, decoded form of the storage API token. Each part of
38 the token is explained, in a human-readable string. Amongst other
39 elements, this command gives the path to where the corresponding
40 article is supposed to be stored.
41 -d, -r
43 Rather than retrieving the specified article, remove the article.
44 This will delete the article out of the news spool and it will not
45 subsequently be retrievable by any part of INN. It's equivalent to
46 "ctlinnd cancel" except it takes a storage API token instead of a
47 message-ID.
48 -H Retrieve only the headers of the article rather than the entire
50 article. This option cannot be used with -d, -r, -i, or -S.
51 -i Show the newsgroup name and article number associated with the
53 token rather than the article itself. Note that for crossposted
54 articles, only the first newsgroup and article number to which the
55 article is associated will be returned.
56 -q Suppress all error messages except usage errors.
58 -R Display the raw article. This means that line endings won't be
60 converted to native line endings and will be left as CRLF
61 sequences; leading periods will still be escaped for sending over
62 NNTP, and the article will end in a CRLF.CRLF sequence.
63 -S Write the article to standard output in the format used by rnews
65 spool files. Multiple articles can be written in this format, and
66 the resulting output can be fed to rnews (on another system, for
67 example) to inject those articles into INN. This option cannot be
68 used with -d, -r, -H, -i, or -R.
69 -s Store the article given on standard input using the normal storage
71 rules for articles as configured in storage.conf(5). Print the new
72 token for the message to standard output if it is stored
73 successfully. If this option is given, no other options except
74 possibly -q should be given.
75
77 If all operations were successful, sm exits with status 0. If an
78 operation on any of the provided tokens fails, sm will exit with status
79 1, even if the operations on other tokens were successful. In other
80 words, if twenty tokens are fed to "sm -r" on stdin, 19 articles were
81 successfully removed, but the sixth article couldn't be found, sm will
82 still exit with status 1.
83 This means that if you need to be sure whether a particular operation
85 succeeded, you should run sm on one token at a time.
86
88 Written by Katsuhiro Kondou <kondou@nec.co.jp> for InterNetNews.
89 Rewritten in POD by Russ Allbery <eagle@eyrie.org>.
90 $Id: sm.pod 9767 2014-12-07 21:13:43Z iulius $
92
94 ctlinnd(8), grephistory(1), history(5), rnews(1), storage.conf(5).
95INN 2.6.3 2015-09-12 SM(1)