Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MAILESTCTL(1)		    General Commands Manual		 MAILESTCTL(1)

NAME
       mailestctl -- control the mailest

SYNOPSIS
       mailestctl [-h] [-S suffix] [-s socket] [-m maildir] command [args ...]

DESCRIPTION
       The  mailestctl	program	 controls  the mailestd(8) daemon.  To use the
       mailest for the search backend for the Mew  program,  see  the  EXAMPLE
       section in mew-mailest(1).

       The options are as follows:

       -S suffix
	       The suffix of the mail files instead of the default .mew.  This
	       option	is   only  used	 only  when  the  mailestctl  invoking
	       mailestd(8) to pass the suffix configuration.  This option  ex-
	       ists  to	keep the compatibility with the	existing "mewest", and
	       it doesn't change  the  suffix  configuration  of  the  running
	       mailestd(8).   See  the mailestd.conf(5)	to configure in	proper
	       way.

       -s socket
	       Use the socket instead of the  default  (maildir)/.mailest.sock
	       to comunicate with mailestd(8).

       -m maildir
	       The  base  directory of the mail	folders	instead	of the default
	       ${HOME}/Mail.

       -h      Show the	usage.

       The following commands are available:

       start   Start the mailestd(8) daemon.

       stop    Stop the	running	mailestd(8) daemon.

       restart
	       Restart the mailestd(8) daemon.

       message-id message-id
	       Search the indexes by the message-id.

       parent-id message-id
	       Search the indexes by the parent	message's message-id.

       csearch [-vu] [-max max]	[-ord ord] [-ic	ic] [-attr attr] phrase
	       Search the indexes of the mail messages in estcmd(1) compatible
	       arguments.  This	command	is used	by "Mew"  though  the  wrapper
	       program	mew-mailest(1)	to search the file names which include
	       the given phrase.  Specify -vu always since  the	 other	output
	       options	are  not  avaiable.  The mailestd(8) daemon will start
	       automatically if	it's not running.

       update [folder]
	       Start the indexes of the	messages.  If the folder is specified,
	       the indexing is done in the specified folder,  otherwise	 index
	       all  folders  following the configuration of mailestd.  A shell
	       globing pattern (like "openbsd-*") is usable  for  the  folder.
	       The  mailestd(8)	 daemon	 will  start automatically if it's not
	       running.

       suspend
	       Suspend the indexing.

       resume  Resume the indexing.

       debug   Increase	the debug level	of the mailestd(8) daemon.

       -- -debug
	       Decrease	the debug level	of the mailestd(8)  daemon.   "--"  is
	       needed	to   speparate	this  command  from  treating  as  the
	       mailestctl program's option.

FILES
       ${HOME}/Mail		Default	maildir.
       (maildir)/.mailest.sock	Unix-domain socket used	for communication with
				mailestd(8)

SEE ALSO
       mailestd(8), mew-mailest(1)

AUTHORS
       The   mailestctl	  program   was	  written    by	   YASUOKA    Masahiko
       <yasuoka@yasuoka.net>.

FreeBSD	ports 15.quarterly	 April 4, 2015			 MAILESTCTL(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mailestctl&sektion=1&manpath=FreeBSD+Ports+15.0.quarterly>

home | help