From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:863f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms12 with LMTPS id AI5FNoGdH2CWTwAAsNZ9tg (envelope-from ); Sun, 07 Feb 2021 07:57:53 +0000 Received: from out1.migadu.com ([2001:41d0:2:863f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id mM68In+dH2ChEAAAB5/wlQ (envelope-from ); Sun, 07 Feb 2021 07:57:51 +0000 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kyleam.com; s=key1; t=1612684671; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=MxZAZaU+8RMr9nn2WrTvz2ycVcLQjkhSOlyjDwn0cgo=; b=VSDYGqDbTQQyFs8hgEZR4gup3ZuS8gGpcNvjCCnt9UfL9lgt0INa2JgJ+fhTPPE8gAnIof ng+2Cggein/VzBc+7qbUKULB9aLQAx+ZtHj283hP5IkITOQK5MO9ocXWN9HTYMDtUfHKHq wWeAGqyKGnUjD5kdGkyis3wB1E81qJSBJJdQVja+6lCE6zdXpXeyI3OtIorB5l24DBkZRZ RYD2dA5taZnXWBElHPoKaz38ZbeJuUiDhS5kT/Ffy3ogLyfshJFFs/eFwX0WYxH7Nw4xuV GeN1jrv6M7drExjJ7yZzyHRjj6ZlQkr8BsK2gl8yjPmJ85D0x/vFEQ5buQ86EA== From: Kyle Meyer To: piem@inbox.kyleam.com Cc: Xinglu Chen Subject: [PATCH 5/5] manual: Add section on "copy public-inbox link" functionality Date: Sun, 7 Feb 2021 02:57:38 -0500 Message-Id: <20210207075738.8752-6-kyle@kyleam.com> In-Reply-To: <20210207075738.8752-1-kyle@kyleam.com> References: <20210207075738.8752-1-kyle@kyleam.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: kyle@kyleam.com X-TUID: zVAjbq/cxRbi Cc: Xinglu Chen --- piem.texi | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/piem.texi b/piem.texi index 070adf4..e3019c7 100644 --- a/piem.texi +++ b/piem.texi @@ -48,7 +48,7 @@ Top * Overview:: * Getting started:: * Applying patches:: -* Injecting messages into a Maildir directory:: +* Miscellaneous functionality:: * Contributing:: Appendices @@ -383,8 +383,11 @@ Applying patches without a public-inbox archive b4-inspired patch extraction. +@node Miscellaneous functionality +@chapter Miscellaneous functionality + @node Injecting messages into a Maildir directory -@chapter Injecting messages into a Maildir directory +@section Injecting messages into a Maildir directory @cindex Maildir public-inbox allows you to follow lists through several mechanisms @@ -441,6 +444,34 @@ Injecting messages into a Maildir directory #'piem-notmuch-known-mid-p) @end lisp +@node Copying public-inbox URLs +@section Copying public-inbox URLs + +@findex piem-copy-mid-url +When referring to a message from a public-inbox archive, a common format +to use is a URL that points to a specific archive and ends with +@code{/$INBOX/$MESSAGE_ID}, e.g., +@url{https://public-inbox.org/meta/20190108015420.GA28903@@dcvr}. +Calling @code{piem-copy-mid-url} (available in the @code{piem-dispatch} +transient) constructs such a URL, using the message ID and inbox +asscociated with the current buffer, and then copies the URL to the kill +ring. When a prefix agument is given, @code{browse-url} is called after +copying the URL. + +@vindex piem-browse-url-browser-function +Note that EWW works nicely with public-inbox's HTTP interface. If you'd +prefer it to be invoked even though it's not your default browser (as +configured by @code{browse-url-browser-function}), you can set +@code{piem-browse-url-browser-function} to @code{eww-browse-url}. + +@findex piem-notmuch-mode +@findex piem-notmuch-show-get-public-inbox-link +For notmuch.el users, there's an additional entry point for copying +public-inbox URLs: enabling @code{piem-notmuch-mode} adds a ``piem'' +candidate to archives offered by +@code{notmuch-show-stash-mlarchive-link} and +@code{notmuch-show-stash-mlarchive-link-and-go}. + @node Contributing @chapter Contributing -- 2.30.0