﻿


                      - IPadr*  by Mario Corsolini - 


                         Version 1.42  for Python

                            URL: www.oipaz.net
                          eMail: OiPaz@oipaz.net

                        ©2004-2010 Mario Corsolini




 -- 0. Table of Contents -----------------------------------------------


    0. Table of Contents
    1. Introduction
    2. Legal Stuff
    3. System Requirements
    4. How to Install
    5. How to Use
    6. How to Uninstall
    7. Feedback, Suggestions, Bug-Reports
    8. Release History
    9. Acknowledgements




 -- 1. Introduction ----------------------------------------------------


    IPadr*  is a small suite containing two command line tools:  IPadr
    publishes  on a web page  the public IP address of a (NATted) host
    and it keeps a text log of its operations;  IPadrLog  analyses the
    log files created by IPadr.




 -- 2. Legal Stuff -----------------------------------------------------


    IPadr*   is  licenced  under  the  Creative  Commons  Attribution-
    NonCommercial-NoDerivatives 4.0 International Licence (CC BY-NC-ND
    4.0). To view a copy of the licence, visit:
            http://creativecommons.org/licenses/by-nc-nd/4.0/




 -- 3. System Requirements ---------------------------------------------


    IPadr*  needs Python (either 2 or 3) and it should work under most
    existing operating systems.




 -- 4. How to Install --------------------------------------------------


    IPadr* does not need any installation: just unzip and run it!

    The best way to use IPadr.py is to run it periodically through the
    scheduler of your operating system.
    It is also possible (and highly advisable) to create a shortcut to
    the IPadrLog.py file where you like best.




 -- 5. How to Use ------------------------------------------------------


    Usage of IPadr.py (parameters between brackets are optional):
        IPadr.py -w:URI -u:NAME -p:PW [-l:PATH] [-m:N] [-c] [-h]
    Options:
        -c      ask for confirmation before exiting;
        -h      print these notes and exit;
        -l:PATH save logs in the provided path;
        -m:N    wait until minutes are congruent to 0 (mod N);
        -p:PW   FTP password;
        -u:NAME FTP username;
        -w:URI  FTP address of the directory receiving IPadr.html.

    Usage of IPadrLog.py  (parameters  between  brackets are optional,
    "x|y" means you must write either x or y):
        IPadrLog.py [options]
    Options:
        -3                 format IPv4 addresses as numbers of exactly
                           three digits;
        -c                 ask for confirmation before exiting;
        -f:A|*.B|*.C|*.D|* show only the  IPv4 addresses  matching the
                           provided pattern;
        -h                 print these notes and exit;
        -l:PATH            look for logs in the provided path;
        -n                 add line numbers;
        -s[:STRING]        code the -t:M table with STRING (default is
                           " 1234567890");
        -t:M               table  cyclicly  coded  addresses  in  time
                           frames of M minutes;
        -y:YEAR1[-[YEAR2]] analyse data from YEAR1 to YEAR2 (use four-
                           digit numbers).

    Any other parameter will be ignored.
    The parameters are case sensitive.




 -- 6. How to Uninstall ------------------------------------------------


    If, for some reason, you do not like IPadr*:  close it, delete its
    folder and any shortcut or scheduling you created.
    That will completely uninstall IPadr*. :-(

    IPadr*  does  NOT  leave any rubbish on the HD or Registry but, if
    you  had  to  install  Python, you may remove it through the usual
    Add/Remove applet of the Control Panel (be careful: it may be used
    by other applications!).




 -- 7. Feedback, Suggestions, Bug-Reports ------------------------------


    Any  comments,  suggestions  and  (most  of  all)  bug-reports are
    welcome. Please use the eMail address: OiPaz@oipaz.net
    It  is  advisable  to  specify  "IPadr*"  in the subject field, to
    report  the  version  of  Python  in  use  and some info about the
    operating system of your computer.




 -- 8. Release History -------------------------------------------------


    Version 1.42 - November 11th, 2010
        First public release.

    [...]

    Version 1.00 - June 21st, 2004
        IPadr*  was  born,  as a  VBScript.  In time it will become at
            first  a Gambas project,  then a Visual Basic project and,
            finally, a Python project.




 -- 9. Acknowledgements ------------------------------------------------


    The author wants to thank all the people who helped him with ideas
    and valuable suggestions, and the beta testers!

    And, obviously, thanks to Laura!!

    Well, that's all about it, happy playing!!!


 -----------------------------------------------------------------------
