.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.

=================================
Arguments common to all utilities
=================================

Description
===========

All Apache Panopticon utilities share a set of common command-line arguments::

  --debug               Turn on debug mode / logging.
  --trace               Turn on trace logging. Implies --debug.
  --log LOG             Log file destination. Defaults to stdout only.
  --username USERNAME   Username
  --password PASSWORD   Password
  --clear-store         Clear password keystore


.. option:: --debug

    Turn on debug mode / logging.

.. option:: --trace

    Turn on trace logging. Implies --debug.

.. option:: --log LOG

    Log file destination. Defaults to stdout only.

.. option:: --username USERNAME

    Username.

.. option:: --password PASSWORD

    Password.

.. option:: --clear-store

    Clear password keystore.

Using & Managing Your Keystore
==============================

The Apache Panopticon command-line scripts all allow for the use of local
keystore so that the user does not have to constantly enter in the username
and password.

Understandably, some users may want to never store their usernames and
passwords to the local keystore.  To disable the use of the keystore simply set
the environmental variable ``PANOPTICON_DISABLE_KEYSTORE``.

.. envvar:: PANOPTICON_DISABLE_KEYSTORE

    If set, the Apache Panopticon command-line scripts will not store the user's
    username and password to the local keystore.