Back to files

NETPROFILER HELP FILE

        This is the help file that goes with the netprofiler shell script 
        usually located at http://www.simnet.is/~gnarlin/index.html
HOW TO INSTALL
        Run install.sh --install as root. If you have a previous version of 
        netprofiler installed it is advisable to uninstall it first by 
        running install.sh --uninstall as root. Please remember that this 
        will also remove all your profiles so if you want to keep them
        then copy them first somewhere. If you are just upgrading and 
        aren't worried about clobbering files you can also run 
        install.sh --force-install. This will simply overwrite all files 
        that exist on the system.
        
        Dependecies are: bash, awk (only most common switches are 
        used, if any), host (from bind tools) and all the most common shell 
        tools which usually come with the distribution of your choice. 
        If there are any problems whatsoever please report them to the 
        address given below.
AUTHOR
        This program was written by Freyr Gunnar Ólafsson. An Icelander 
        who currently lives in Reykjavík. I can be reached at 
        gnarlin@utopia.is. Please report all bugs.
PURPOSE OR WHAT THIS PROGRAM IS
        To save the settings of network devices into files with 
        apropriate names for each device into a folder with a name 
        specified by the user. These are called netprofiles. 
        It is then easy to change the settings to those saved in the 
        apropriate profile.
USAGE
        configuration directory is hard coded to be /etc/netprofiler
        the programs configure file is /etc/netprofiler/netprofiler.conf
                EXAMPLE OPTIONS:
                        verbose="[yes][no]"
                        ping_host="somehost.com"
                        dhcp_client="[dhcpcd][pump][dhclient][udhcpc]" 
                        
        profiles are always in /etc/netprofiler/profiles
        general settings for each profile is at 
        /etc/netprofiler/profiles/[profilename]/general.settings
                This file contains among other things the dns entry 
                list which goes to /etc/resolv.conf
                along with the default gateway for that profile.
                EXAMPLE OPTIONS:
                        route="192.168.1.254"
                        nameservers="192.168.1.2 192.168.1.3"
                        dhcp="no"
                        
        the filter file is at /etc/netprofiler/filtered.list
                This file has a list of devices that you DON'T 
                want netprofiler to affect. This should almost
                always contain at least the lo (local) device. 
                EXAMPLES OPTIONS:
                        lo
                        tunl0
                        [any network device]

        Each device file is located at 
        /etc/netprofiler/profiles/[profilename]/eth0 for example.
                This file containes all the settings for the 
                eth0 network device. 
                EXAMPLE OPTIONS:
                        ip="192.168.1.1"
                        netmask="255.255.255.0"
                        route="192.168.1.254"
                                please note that if a route is 
                                specified within a device file and 
                                not in general.settings then the 
                                default gw is assumed to be this 
                                variable via that specific device.
                        essid="someessid"
                                The wireless essid. 
                        key="key_in_hex"
                                So far the key MUST be specified in 
                                hex. This will be changed later. 
                                Also multiple keys are not supported 
                                yet. There is also a known bug with 
                                keys that have spaced in them. 
                                They won't work correctly.
                                In short: network keys don't work
                                well. You have been warned! I will
                                fix this as soon as eighter the sun
                                goes out or I stop being lazy.
                                Whichever comes first.
WHAT THIS PROGRAM IS NOT
        This program is not a DHCP server, and DHCP client nor is it 
        a replacement for ifconfig, route or any of the default network
        configuration tools that come with your distro of choice.

WARRANTY

This program comes without any warranty of any kind.