| 1 |
IM Usage |
| 2 |
|
| 3 |
<<<Message Spool Keyword>>> |
| 4 |
|
| 5 |
IM treats local mail folders, local/remote newsgroup spools, and local |
| 6 |
news folders. For historical reasons, mail folders start with "+" |
| 7 |
(e.g. "+inbox). Newsgroup spools are identified by the "-" keyword |
| 8 |
(e.g. "-gnu.emacs.sources"). Directories to store locally saved news |
| 9 |
messages are indicated by the "=" keyword (e.g. "=comp.lang.perl"). |
| 10 |
|
| 11 |
<<<Option Convention>>> |
| 12 |
|
| 13 |
(0) Options are categorized into canonical, abbreviate, and |
| 14 |
compatible. Many options takes "value". "value" categorized into |
| 15 |
string(s), boolean(b|B), number(i), and folder(f|F). (For more |
| 16 |
information, see "IM/Config.pm") |
| 17 |
|
| 18 |
(1) Canonical options conform the "--key=value" style. |
| 19 |
|
| 20 |
"=value" can be omitted. If omitted, the following rules are applied: |
| 21 |
|
| 22 |
boolean(b) -> "on" |
| 23 |
boolean(B) -> "off" |
| 24 |
string(s) -> "" |
| 25 |
folder(f|F) -> undef |
| 26 |
|
| 27 |
For example, the "--help" option is boolean(b). Its canonical form is |
| 28 |
"--help=on" or "--help=off". "--help" is treated as "--help=on". |
| 29 |
|
| 30 |
(Please note that you can use "yes", "true" and "1" instead of |
| 31 |
"on". As well, "no", "false" and "0" instead of "off") |
| 32 |
|
| 33 |
(2) Abbreviate and compatible options conform "-k value" for string(s) |
| 34 |
and folder(f|F) OR "-k" for boolean(b|B). |
| 35 |
|
| 36 |
If abbreviate option, it is an abbreviation of a canonical option. For |
| 37 |
example, "-h" means "--help" whereas "-n" indicates "--noharm". |
| 38 |
|
| 39 |
Compatible options are provided to maintain backward compatibility to |
| 40 |
good old commands. One compatible option may have the same effect |
| 41 |
of regarding canonical options. |
| 42 |
|
| 43 |
(3) All command supports canonical options. Each command chooses |
| 44 |
abbreviate or compatible, not both! |
| 45 |
|
| 46 |
The current program which chooses compatible options is only "imput". |
| 47 |
(Maybe "imget" in the future.) |
| 48 |
|
| 49 |
(4) The "+" keyword means "--src=+" or "--dst=+" while the "=" keyword |
| 50 |
means "--src==" or "--dst==" if folder(F) options is |
| 51 |
specified. Examples are shown below: |
| 52 |
|
| 53 |
+inbox -> --src=+inbox |
| 54 |
=comp.lang.perl -> --src==comp.lang.perl |
| 55 |
|
| 56 |
Also "-", "/", "~", "%", and "[a-z]:" will be expanded in this manner. |
| 57 |
|
| 58 |
To know these keywords are treated as "--src=" or "--dst=", see the |
| 59 |
help message of each command. |
| 60 |
|
| 61 |
(5) Environment variables, config parameters and command line options |
| 62 |
but backward compatibility ones are equivalent and are evaluated in |
| 63 |
order. |
| 64 |
|
| 65 |
<<<Help Message>>> |
| 66 |
|
| 67 |
Every command has "--help" option to display its version, name, and |
| 68 |
options. |
| 69 |
|
| 70 |
Help displays actual configuration/option value. For example, |
| 71 |
'imls --help' returns: |
| 72 |
--src=<folder> (-s)(+inbox) |
| 73 |
while 'imls --help --src=+draft' shows: |
| 74 |
--src=<folder> (-s)(+draft) |
| 75 |
|
| 76 |
For this reason, "--help" is always "on" when displaying help message. |
| 77 |
|
| 78 |
Some commands have "--noharm" or "-n" option. If specified, the |
| 79 |
command tells you what will happen if not specified. It's like |
| 80 |
"make -n". |
| 81 |
|
| 82 |
<<<IM Commands>>> |
| 83 |
|
| 84 |
'imput' ('send') |
| 85 |
Post a message by mail and/or news. |
| 86 |
|
| 87 |
'imget' ('inc') |
| 88 |
Get message(s) in the mail spool |
| 89 |
|
| 90 |
'imls' ('scan') |
| 91 |
List up the contents of the folder. |
| 92 |
|
| 93 |
'imcat' ('show') |
| 94 |
Show the contents of the message. |
| 95 |
|
| 96 |
'imcd' ('folder') |
| 97 |
Change the current folder. |
| 98 |
|
| 99 |
'immv' ('refile') |
| 100 |
Move message(s) from the source folder to the destination folder(s). |
| 101 |
|
| 102 |
'imrm' |
| 103 |
Move message(s) from the source folder to the +trash folder. |
| 104 |
|
| 105 |
'imclean' |
| 106 |
Remove message(s). |
| 107 |
|
| 108 |
'imgrep' ('pick') |
| 109 |
Enumerate message(s) matched given patterns. |
| 110 |
|
| 111 |
'impath' ('mhpath' and 'folder -all') |
| 112 |
Expand a folder to a file path. |
| 113 |
List up folders. |
| 114 |
|
| 115 |
'imali' ('ali') |
| 116 |
Expand an alias given in .im/Aliases. |
| 117 |
|
| 118 |
'impack' ('folder -pack') |
| 119 |
Pack messages in a folder. |
| 120 |
|
| 121 |
'imsort' ('sortm') |
| 122 |
Sort messages in a folder. |
| 123 |
|
| 124 |
'imhist' |
| 125 |
Treat history database. |
| 126 |
|
| 127 |
'imstore' ('rcvstore') |
| 128 |
Store a message from stdin to a folder. |
| 129 |
|
| 130 |
'imsetup' ('install-mh') |
| 131 |
Set up for IM. |
| 132 |
|
| 133 |
<<<Config Files>>> |
| 134 |
|
| 135 |
The config syntax is equivalent to the options style. That is, each |
| 136 |
line is in the "key=value" form. For more details, see |
| 137 |
"cnf.im/SiteConfig" and "dot.im/Config". |
| 138 |
|
| 139 |
Each command reads config the following order. |
| 140 |
|
| 141 |
"/usr/local/lib/im/SiteConfig" (for site-wide configuration) |
| 142 |
"~/.im/Config" (for private configuration) |
| 143 |
|
| 144 |
Next it evaluates environment variables if required then the command |
| 145 |
options. |
| 146 |
|
| 147 |
<<<Scan Format>>> |
| 148 |
|
| 149 |
The '%{width}{header-type}' syntax is available. You can define any |
| 150 |
header-type as you want. Default valid 'header-type's are: |
| 151 |
|
| 152 |
%n message number |
| 153 |
%d raw Date: field |
| 154 |
%f MIME decoded From: field |
| 155 |
%t MIME decoded To: filed |
| 156 |
%g raw Newsgroups: field |
| 157 |
%a friendly From: field |
| 158 |
%A If this message is originated by yourself, friendly To: |
| 159 |
or raw Newsgroups: is displayed in 'To:xxx' or 'Ng:xxx' |
| 160 |
format, respectively. Otherwise, friendly From: field is |
| 161 |
displayed. |
| 162 |
%P Similar to %A, but diplay row address of mail sender |
| 163 |
instead of friendly From: field, just like mh-e. |
| 164 |
%i indent to display thread |
| 165 |
%s MIME decoded Subject: field |
| 166 |
%S indented MIME decoded Subject (same as %i+%s) |
| 167 |
%b a part of body extracted with heuristic |
| 168 |
%m Multipart type |
| 169 |
'S'igned, 'E'ncrypt, 'M'ultipart, 'P'artial or none |
| 170 |
%p mark '*' if the message is destined to you |
| 171 |
%D mark 'D' if the message is duplicated |
| 172 |
%M %p+%D |
| 173 |
%F folder path |
| 174 |
%K file block size (1024 bytes/block) |
| 175 |
|
| 176 |
%y year |
| 177 |
%c month (digit) |
| 178 |
%C month (string) |
| 179 |
%e mday |
| 180 |
%h hour |
| 181 |
%E min |
| 182 |
%G sec |
| 183 |
|
| 184 |
Examples: |
| 185 |
|
| 186 |
(1) Form="%5n %m%d %-14A %-18S %b" |
| 187 |
|
| 188 |
87 M04/07 Kazu Yamamoto Subject This is body. |
| 189 |
|
| 190 |
(2) Form=%5n%M%m%d %-14A %-18S %b" |
| 191 |
|
| 192 |
87 M04/07 Kazu Yamamoto multipart This is duplicated. |
| 193 |
87*S04/07 Motonori Naka signed This is for you. |
| 194 |
89DM04/07 Kazu Yamamoto multipart This is duplicated. |
| 195 |
|
| 196 |
If you don't find favorite header-types, you can define your original |
| 197 |
header-types by yourself. For more information, see "dot.im/scan.sbr" |
| 198 |
and "IM/Scan.pm". |