Metadata-Version: 1.1
Name: tcconfig
Version: 0.1.2
Summary: Simple tc (traffic control) command wrapper
Home-page: https://github.com/thombashi/tcconfig
Author: Tsuyoshi Hombashi
Author-email: gogogo.vm@gmail.com
License: MIT License
Description: **tcconfig**
        
        .. image:: https://travis-ci.org/thombashi/tcconfig.svg?branch=master
           :target: https://travis-ci.org/thombashi/tcconfig
        
        .. contents:: Table of contents
           :backlinks: top
           :local:
        
        About
        =====
        
        Simple tc (traffic control) command wrapper.
        
        Installation
        ============
        
        .. code:: console
        
            pip install tcconfig
        
        Usage
        =====
        
        Set traffic control
        -------------------
        
        tcset is a command to impose traffic control to a network interface
        (device).
        
        tcset help
        ~~~~~~~~~~
        
        .. code:: console
        
            usage: tcset [-h] [--version] [--logging] [--stacktrace] [--debug | --quiet]
                         --device DEVICE [--rate RATE] [--delay DELAY] [--loss LOSS]
                         [--overwrite]
        
            optional arguments:
              -h, --help       show this help message and exit
              --version        show program's version number and exit
              --debug          for debug print.
              --quiet          suppress output of execution log message.
        
            Miscellaneous:
              --logging        output execution log to a file (tcset.log).
              --stacktrace     display stack trace when an error occurred.
        
            Traffic Control:
              --device DEVICE  network device name
              --rate RATE      network bandwidth [K|M|G bps]
              --delay DELAY    round trip network delay [ms] (default=0)
              --loss LOSS      round trip packet loss rate [%] (default=0)
              --overwrite      overwrite existing setting
        
        e.g. Set a limit on bandwidth up to 100Kbps
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: console
        
            # tcset --device eth0 --rate 100k
        
        e.g. Set 100ms network delay
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: console
        
            # tcset --device eth0 --delay 100
        
        e.g. Set 0.1% packet loss
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: console
        
            # tcset --device eth0 --loss 0.1
        
        e.g. All of the above at onece
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: console
        
            # tcset --device eth0 --rate 100k --delay 100 --loss 0.1
        
        Delete traffic control
        ----------------------
        
        tcdel is a command to delete traffic control from a network interface
        (device).
        
        tcdel help
        ~~~~~~~~~~
        
        .. code:: console
        
            usage: tcdel [-h] [--version] [--logging] [--stacktrace] [--debug | --quiet]
                         --device DEVICE
        
            optional arguments:
              -h, --help       show this help message and exit
              --version        show program's version number and exit
              --debug          for debug print.
              --quiet          suppress output of execution log message.
        
            Miscellaneous:
              --logging        output execution log to a file (tcset.log).
              --stacktrace     display stack trace when an error occurred.
        
            Traffic Control:
              --device DEVICE  network device name
        
        e.g.
        ~~~~
        
        .. code:: console
        
            # tcdel --device eth0
        
        Dependencies
        ============
        
        -  `thutils <https://github.com/thombashi/thutils>`__
        
        Test dependencies
        -----------------
        
        -  `pytest <https://pypi.python.org/pypi/pytest>`__
        -  `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
        -  `tox <https://pypi.python.org/pypi/tox>`__
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: System :: Networking
