LUCI Documentation

[main]     [download]     [tutorial]     [documentation]     [examples]

The syntax of the luci command is:

       luci [options] [description_file]
       If no desc file is given, the navigator will be run.
	-h|--help     this help message
	-v|--version  display the current version of the program
	--license     display information about the license
	-d|--descdir  description files directory (default to /etc/luci)
	-f|--force    don't ask for confirmation for creating a new config file

So, the easy way to use LUCI is to type :
luci foobar

Where foobar is the name of a description file (see the tutorial for a definition of terms like "description file"). LUCI will read the description file, then read the config file described and display a window showing the content of the config file (you can go to the examples pages to see some screenshots of the result).
At the bottom of the window, are two buttons:OK will write the file with the actual values in the LUCI window and exits while Cancel will quit LUCI without saving anything.

If the config file doesn't exist when you run the command, LUCI will ask if it should create it or exit. You can override this question by using the --forcedir (or -f) option. In this case LUCI will automatically create the config file without asking anything.

You can also call LUCI without any argument:


In this case, LUCI will read all the description files installed on your system. The standard place for such files is in /etc/luci. Then LUCI will display a list of all the files it found in a tree. This window is called the navigator. The tree will be constructed according the directory structure under /etc/luci. So you can make dirs and subdirs to create sections and subsections (like system/network/apache/httpd.conf for example).
Clicking on a leaf of the tree will display the content of the corresponding configuration file, just like if you called LUCI with the name as an argument (there is also some screenshots of the navigator in the examples section).
Clicking on the OK or Cancel button will close the right window, but not the navigator window. You 'll have to close the window in order to quit LUCI.

If you want to install your description file in an other place than /etc/luci (if you're not root for example), or if you want to use an alternate set of files, you can use the --descdir (or -d) switch. By using this option, you tell LUCI to search the description files in the directory you specify:

luci -d /tmp/luci

Valid HTML 4.0!