X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=manpages%2Fnotmuch-1.mdwn;h=5a276e5fcf1567a2a0f4c791cfac28e3abb6dca4;hb=6562766d20047abcb3bab0d88a1e5849baaae76d;hp=dbf4b8c97988a72abf640ada072fcac012532973;hpb=8b6746d22f18e39db67f878267cc8415eef9559a;p=notmuch-wiki diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index dbf4b8c..5a276e5 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -12,7 +12,7 @@

DESCRIPTION

-       Notmuch  is a command-line based program for indexing, searching, read-
+       Notmuch  is a command-line based program for indexing, searching, read‐
        ing, and tagging large collections of email messages.
 
        This page describes how to get started using notmuch from  the  command
@@ -21,16 +21,16 @@
        also accessible via notmuch help show
 
        The  quickest  way  to get started with Notmuch is to simply invoke the
-       notmuch command with no arguments, which will interactively  guide  you
+       notmuch command with no arguments, which will interactively  guide  you
        through the process of indexing your mail.
 

NOTE

-       While the command-line program notmuch provides powerful functionality,
-       it does not provide the most convenient interface for that  functional-
+       While the command-line program notmuch provides powerful functionality,
+       it does not provide the most convenient interface for that  functional‐
        ity.  More  sophisticated interfaces are expected to be built on top of
-       either the command-line interface, or more likely, on top of  the  not-
+       either the command-line interface, or more likely, on top of  the  not‐
        much  library  interface.  See  http://notmuchmail.org  for  more about
        alternate interfaces to notmuch. The emacs-based interface  to  notmuch
        (available under emacs/ in the Notmuch source distribution) is probably
@@ -39,20 +39,16 @@
 
 

OPTIONS

-       Supported global options for notmuch include
+       Supported global options for notmuch include
 
-           --help
+          --help Print a synopsis of available commands and exit.
 
-                  Print a synopsis of available commands and exit.
+          --version
+                 Print the installed version of notmuch, and exit.
 
-           --version
-
-                  Print the installed version of notmuch, and exit.
-
-           --config=FILE
-
-                  Specify the configuration file to use.  This  overrides  any
-                  configuration file specified by ${NOTMUCH_CONFIG}.
+          --config=FILE
+                 Specify the configuration file to  use.  This  overrides  any
+                 configuration file specified by ${NOTMUCH_CONFIG}.
 

COMMANDS

@@ -63,36 +59,36 @@ (or to reconfigure it later). The setup command will prompt for your full name, your primary email - address, any alternate email addresses you use, and the directory con- - taining your email archives. Your answers will be written to a configu- + address, any alternate email addresses you use, and the directory con‐ + taining your email archives. Your answers will be written to a configu‐ ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config . - This configuration file will be created with descriptive comments, mak- + This configuration file will be created with descriptive comments, mak‐ ing it easy to edit by hand later to change the configuration. Or you can run notmuch setup again to change the configuration. - The mail directory you specify can contain any number of sub-directo- - ries and should primarily contain only files with individual email mes- + The mail directory you specify can contain any number of sub-directo‐ + ries and should primarily contain only files with individual email mes‐ sages (eg. maildir or mh archives are perfect). If there are other, non-email files (such as indexes maintained by other email programs) then notmuch will do its best to detect those and ignore them. Mail storage that uses mbox format, (where one mbox file contains many - messages), will not work with notmuch. If that's how your mail is cur- + messages), will not work with notmuch. If that's how your mail is cur‐ rently stored, it is recommended you first convert it to maildir format with a utility such as mb2md before running notmuch setup . - Invoking notmuch with no command argument will run setup if the setup + Invoking notmuch with no command argument will run setup if the setup command has not previously been completed.

  OTHER COMMANDS

-       Several of the notmuch commands accept search terms with a common  syn-
-       tax. See notmuch-search-terms(7) for more details on the supported syn-
+       Several of the notmuch commands accept search terms with a common  syn‐
+       tax. See notmuch-search-terms(7) for more details on the supported syn‐
        tax.
 
-       The search, show and  count  commands  are  used  to  query  the  email
-       database.
+       The search, show and count commands are used to query the  email  data‐
+       base.
 
        The  reply  command  is  useful  for  preparing a template for an email
        reply.
@@ -113,18 +109,15 @@
        of notmuch.
 
        NOTMUCH_CONFIG
-
-              Specifies the location of the notmuch configuration  file.  Not-
+              Specifies the location of the notmuch configuration  file.  Not‐
               much  will  use  ${HOME}/.notmuch-config if this variable is not
               set.
 
        NOTMUCH_TALLOC_REPORT
-
               Location to  write  a  talloc  memory  usage  report.  See  tal-
               loc_enable_leak_report_full in talloc(3) for more information.
 
        NOTMUCH_DEBUG_QUERY
-
               If  set to a non-empty value, the notmuch library will print (to
               stderr) Xapian queries it constructs.
 
@@ -132,8 +125,8 @@

SEE ALSO

        notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5),
-       notmuch-insert(1),      notmuch-new(1),      notmuch-reply(1),     not-
-       much-restore(1),   notmuch-search(1),   notmuch-search-terms(7),   not-
+       notmuch-insert(1),      notmuch-new(1),      notmuch-reply(1),     not‐
+       much-restore(1),   notmuch-search(1),   notmuch-search-terms(7),   not‐
        much-show(1), notmuch-tag(1)
 
        The notmuch website: http://notmuchmail.org
@@ -159,4 +152,4 @@
        2014, Carl Worth and many others
 
-

0.18

+

0.18.1