From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 85E5A431FC9 for ; Sat, 20 Jul 2013 17:08:25 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.799 X-Spam-Level: X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FelO8tbu+6vk for ; Sat, 20 Jul 2013 17:08:02 -0700 (PDT) Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 9EF35431FBF for ; Sat, 20 Jul 2013 17:08:02 -0700 (PDT) Received: by mail-pb0-f53.google.com with SMTP id xb12so5761073pbc.12 for ; Sat, 20 Jul 2013 17:08:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=YlKctHy8ZjmwXvT4J62MFzXRJhriyRxWA9KFRxwobx8=; b=fKaP+Mc0JSKy7McU3MYge8p+zqsvzhqPdMXLfVzdO+MERuejyLxI89MCRspqvZSDlz 787xKXXpq/eroAhkSPaxmip/rg3olWGQtWVyvFld4L21lQU3Xyufrf4IUw3B9tmKKsEV akpNGYcmSm459c692W4CMpEh6CbypGf3n54XqNMfms65O/tfBiTO7p+Diucwkolelm5m nIxGrMSAZL+IG3gfkMkOX2Jlulvsyr+iU841c0/ltUNdjL95r+ZsAVhr0PqSzYysdizy KmJsEod27Pi2jrEyYgFyx9z9Ax2eMM6C09OaG7i4T5+P9FjfBpjo5NDMwNJM7yqR1h06 cDRQ== X-Received: by 10.68.36.230 with SMTP id t6mr24280459pbj.15.1374365281989; Sat, 20 Jul 2013 17:08:01 -0700 (PDT) Received: from localhost (215.42.233.220.static.exetel.com.au. [220.233.42.215]) by mx.google.com with ESMTPSA id bs3sm27277988pbc.42.2013.07.20.17.07.58 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Sat, 20 Jul 2013 17:08:00 -0700 (PDT) From: Peter Wang To: notmuch@notmuchmail.org Subject: [PATCH 2/3] man: document insert --must-index Date: Sun, 21 Jul 2013 10:07:33 +1000 Message-Id: <1374365254-13227-2-git-send-email-novalazy@gmail.com> X-Mailer: git-send-email 1.7.12.1 In-Reply-To: <1374365254-13227-1-git-send-email-novalazy@gmail.com> References: <1374365254-13227-1-git-send-email-novalazy@gmail.com> X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 21 Jul 2013 00:08:25 -0000 Add documentation for the new option. --- man/man1/notmuch-insert.1 | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1 index d5202ac..44c18d8 100644 --- a/man/man1/notmuch-insert.1 +++ b/man/man1/notmuch-insert.1 @@ -55,15 +55,42 @@ Otherwise the folder must already exist for mail delivery to succeed. .RE + +.RS 4 +.TP 4 +.B "--must-index" + +The default behaviour of +.B notmuch insert +is to succeed if the message is added to the mail directory, even if +the message could not be indexed and added to the notmuch database. +In the latter case, a warning will be printed to standard error but +the message file will be left on disk. + +The +.B "--must-index" +option causes +.B notmuch insert +to fail if the message could not be added to the notmuch database, +and the newly-created message file deleted. + +Failure to set tags does not consitute a failure of the overall +command. + +.RE .SH EXIT STATUS -This command returns exit status 0 if the message was successfully -added to the mail directory, even if the message could not be indexed -and added to the notmuch database. In the latter case, a warning will -be printed to standard error but the message file will be left on disk. +This command returns exit status 0 on success. +On failure, it returns a non-zero exit status. -If the message could not be written to disk then a non-zero exit -status is returned. +.TP +.B 1 +Failed to write the message to disk. +.TP +.B 2 +Failed to index the message, and +.B "--must-index" +was specified. .RE .SH SEE ALSO -- 1.7.12.1