Difference between revisions of "lssmb"

From Cliquesoft
Jump to: navigation, search
Line 7: Line 7:
 
Among our standard 'help', 'version', and 'update' ACTIONs, this project also contains two others - 'install' and 'show'.  The 'install' ACTION simply installs the script in the "~/.bin" directory (XiniX) and "/usr/bin" for typical GNU/Linux distros.  To see how easy it is to install, see the examples section.
 
Among our standard 'help', 'version', and 'update' ACTIONs, this project also contains two others - 'install' and 'show'.  The 'install' ACTION simply installs the script in the "~/.bin" directory (XiniX) and "/usr/bin" for typical GNU/Linux distros.  To see how easy it is to install, see the examples section.
  
Now that  
+
The other ACTION, 'show', will perform most of the desired work.  It's important to note that the returned information will be different based on the value provided for the <i>--target</i> OPTION.  For simplicity and ease-of-use, if <i>--target</i> contains just a server name, ip address, or FQDN (e.g. --target=servername.mydomain.local, --target="192.168.0.10", etc), the results will show all of the shares currently being offered by that server.  However, if the <i>--target</i> value includes a share name and optional path (e.g. --target='\\servername\share', --target='\\192.168.0.10\share\dir\path'), lssmb will display the entire contents of that directory (which can further be refined by using the <i>--match<i> option).  Notice that when providing a share and optional path in the examples, each value was enclosed by <b>single</b> quotes and the server was preceeded by double back-slashes as this is the common syntax for network interaction within a Microsoft Windows OS environment.  If the network share value isn't enclosed by double back-slashes, an error will occur.
  
 
===OPTIONS===
 
===OPTIONS===

Revision as of 21:47, 24 March 2012

As our project writeup specifies, this is a nice little utility script for viewing available shares offered by a Windows (or SMB/CIFS in Unix) file server as well as providing the ability to see the (matching) contents of a specified directory within a share. Not unlike our other bash-script-based software, this project relies on our clAPI framework for various functionality, so be sure this dependency is satisfied before using.

Terms

This projects' codebase is licensed under the AGPLv3 unless a valid CPL has been purchased. More information about both of these licenses can be found under the "Our Licenses" link of our homepage.

ACTIONS

Among our standard 'help', 'version', and 'update' ACTIONs, this project also contains two others - 'install' and 'show'. The 'install' ACTION simply installs the script in the "~/.bin" directory (XiniX) and "/usr/bin" for typical GNU/Linux distros. To see how easy it is to install, see the examples section.

The other ACTION, 'show', will perform most of the desired work. It's important to note that the returned information will be different based on the value provided for the --target OPTION. For simplicity and ease-of-use, if --target contains just a server name, ip address, or FQDN (e.g. --target=servername.mydomain.local, --target="192.168.0.10", etc), the results will show all of the shares currently being offered by that server. However, if the --target value includes a share name and optional path (e.g. --target='\\servername\share', --target='\\192.168.0.10\share\dir\path'), lssmb will display the entire contents of that directory (which can further be refined by using the --match<i> option). Notice that when providing a share and optional path in the examples, each value was enclosed by single quotes and the server was preceeded by double back-slashes as this is the common syntax for network interaction within a Microsoft Windows OS environment. If the network share value isn't enclosed by double back-slashes, an error will occur.

OPTIONS

Explainations of ACTIONs OPTIONs go here

Examples

Installation is a simple 2-step process...

$ cd /path/to/uncompressed/package
$ ./lssmb install

Developers

Dave Henderson (dhenderson@cliquesoft.org)