Home     News     Download     Documentation     Forum     FAQ     TODO     Donate  
BPWS v2.0 Documentation

1) Getting the source
2) Installing
3) Using the script
a) Running bpws
b) Adding a Network
c) Editing a Network
d) Deleting a Network
4) Manually altering bpws.conf file
5) Features and untested ideas

1) Getting the source:
     This step is pretty easy, if your reading this you are most likely on our website. Goto the Download section and get it.

2) Installing:
     Extract bpws<version>.tar.gz file. (ex. tar -zxvf bpws.tar.gz) 'cd' into the created directory and shell the installer. (ex. 'sh install.sh' or './install.sh')
     This will run the quick installer, which just copies the bpws program to /usr/bin and creates /etc/bpws.conf.

3) Using the script:
     a) Running bpws:
          As root, simply type 'bpws' to run it with the gui.
          If you know the network number or name you can use it as an argument.
          For example. If network #1 is also called 'Home' you can type 'bpws 1' or 'bpws Home' and you will be connected asap!
     b) Adding a Network:
          After you run bpws you will notice the options at the bottom of the gui. Type 'a' to add a network.
          The script will detect what # is next available and ask you for a name. I recommend using a name without spaces, and characters other than the standard alphabet and numbers (ie, no ~ ' “ = + { } [ ] ; : / ? < > . ,)
          Also the name you put in is case sensitive. So it would be a good idea to use all lowercase letters.
          You will be asked for a Name, a key if needed (this would be the WEP key. We have not testing this using WPA as we do not have the equipment to do so.), and if you want to use 'dhcpcd' to get you an IP address.
          If you say 'y' you are done.
          If you say 'n' you will be asked what IP you want, the subnet (usually, and the gateway.
          TIP: Your gateway is usually the same as you IP address except the last number is 1. For example, if your IP is '' then your gateway would probably be ''.
     c) Editing a Network:
          After running bpws you type 'e' to edit a network. You will then be asked what network you wish to edit. Type in the number of the network or it's name.
          You will be shown the current settings for that network. Then be asked the same questions as when you add a network. The difference is there will be brackets '[]' showing what your current setting is. If you are ok with that simply hit enter to keep the setting. The only thing you can't hit enter on is where you are asked if you with to use 'dhcpcd'.
          Just like most of the script, it's pretty self explanatory. Just read it and we are sure you will do fine.
     d) Deleting a Network:
          Just type the name or number you wish to delete. It will be removed ASAP.

4) Manually altering bpws.conf file:
     The layout of bpws.conf is to ensure information is easily read, edited, or removed. It is set like so:
     The 'x' after the number and name are to ensure information is retrieved properely. We are new to bash scripting so I thought it would be best.
     The easiest way it to open bpws.conf in a text editor like 'pico' As long as what you do follows the structure set you won't have a problem. I personally find it easier to just use the script to add, edit, or delete network listings.
5) Features and untested ideas:
          BPWS has a few good features right now, most of which have already been explained. There is the idea of using 'sudo' to run the program. If you have sudo setup properly (we think) you can type 'sudo bpws' and have it work. This is currently untested.

©2007 bpws - bpws Personal Wireless Script

GNU Image courtesy of GNU.org
'#!/bin/bash' ie. Bash Shell (The best damn shell)
Hosting Provided by Source Forge
SourceForge.net Logo