view release on metacpan or  search on metacpan

bin/zapzi  view on Meta::CPAN

=item * Nothing - will do no distribution (the default)

=back

To use this at publication time, set the C<--distribute> or C<-d>
option to the publish command. Some examples:

  $ zapzi publish -d copy /path/to/directory
  $ zapzi publish -d email me@my.address.com
  $ zapzi publish -d script /home/user/bin/myscript.sh

To set this up so distribution happens every time you publish without
needing to provide the C<-d> command line option, set the
C<distribution_method> and C<distribution_destination> config
parameters. See the Configuration section below for more details.

For email distribution, the From address used will be the same as the
To address. You can override this by setting the
C<EMAIL_SENDER_TRANSPORT_from> environment variable. By default, email
will be sent via the local sendmail service on your machine; if you
want to send by SMTP set the C<EMAIL_SENDER_TRANSPORT> environment
variable to SMTP and configure the below environment variables as
appropriate. You can also set any other options documented by
L<Email::Sender>.

=over 4

=item EMAIL_SENDER_TRANSPORT_host: the name of the host to connect to;
defaults to localhost

=item EMAIL_SENDER_TRANSPORT_ssl: if set, connect via SSL; defaults to
false

=item EMAIL_SENDER_TRANSPORT_port: port to connect to; defaults to 25
for non-SSL, 465 for SSL

=item EMAIL_SENDER_TRANSPORT_timeout: maximum time in secs to wait for
server; default is 120

=item EMAIL_SENDER_TRANSPORT_sasl_username: the username to use for
auth; optional

=item EMAIL_SENDER_TRANSPORT_sasl_password: the password to use for
auth; required if username is provided

=back

=head2 SHOWING AND EXPORTING

Instead of publishing, if you want to see a copy of an article use
C<zapzi show> to view the article in a browser or C<zapzi export> to
send a copy of the readable article to the standard output. Both these
commands will not archive the article.

You can chain together adding and showing, eg

  $ zapzi add show README.md

will add a copy of README.md to the database and then open a browser
to show how it looks in readable format.

=head1 SUPPORT AND DEVELOPMENT

Bugs and requested issues can be reported at Github. Pull requests are
also very welcome; please try to follow the existing style and
organisation of the module.

  https://github.com/rupertl/app-zapzi/

=head1 FUTURE PLANS

=over 4

=item * Improve text extraction and formatting - complex pages may not
render correctly or may miss sections at present

=item * Support other ways to fetch articles, eg FTP or IMAP for email.

=item * Support other article formats, eg mbox/maildir.

=item * Add the ability to read sources with state, eg RSS feeds.

=item * Publish to other eBook formats such as PDF.

=back

=head1 NAME

Zapzi comes from the Chinese word 雜誌, meaning magazine. It is
pronounced ZAAP-zi in Cantonese.

=head1 CONFIGURATION

To view or change configuration variables use the C<config get> or
C<config set> commands, eg:

  $ zapzi config get                      # to see all set variables
  $ zapzi config get publish_format       # to see one variable
  $ zapzi config set publish_format EPUB  # to set a variable

The following configuration variables are available

=over 4

=item publish_format

The eBook format Zapzi will use when running the C<publish> command.
Default is MOBI; can be set to EPUB or HTML.

=item publish_encoding

The encoding used to create an eBook when running the C<publish>
command. Default is unset, which means Zapzi will choose the best
encoding for the publication format. Can be set to UTF-8 or
ISO-8859-1.

=item distribution_method

The method used to automatically distribute published eBook files. Can
be either 'Copy', 'Script' or 'Nothing'. Default is 'Nothing'.