lxpanel.hints(5)

Name
lxpanel.hints - Configuration hints for lxpanel plugins

Description

This text collects some background information for configuration of plugins available for lxpanel(1).

The templates below use keywords boolean, integer, and string to denote the expected type of value for each instance. Currently boolean supports only 0 and 1 values. A few exceptions below are using explicit values in order to clarify the common usage. The plugins are introduced by name in a semi-random fashion. In practice a mixture of different stanzas Plugin are written in the order that they are to produce in the actual panel on the desktop.

Available plugins

menu

    Plugin {
        type = menu
        Config {
            name = string
            image = string

            system {
            }

            separator {
            }

            item {
                command = string
                image = string
            }
        }
    }

dirmenu

    Plugin {
        type = dirmenu
        Config {
            name = string
            image = string
            path = string
        }
    }

taskbar

    Plugin {
        type = taskbar

        expand = integer
        LaunchTaskBarMode = integer
        Config {
            tooltips = boolean
            IconsOnly = boolean
            ShowAllDesks = boolean
            SameMonitorOnly = boolean
            UseMouseWheel = boolean
            UseUrgencyHint = boolean
            FlatButton = boolean
            GroupedTasks = boolean
            DisableUpscale = boolean
            UseSmallerIcons = boolean
            MaxTaskWidth = integer
            spacing = integer
        }
    }

launchbar

    Plugin {
        type = launchbar
        Button {
            image = string
            tooltip = string
            action = string
            path = string
            terminal = boolean
        }
        Button {
            id = lxde-logout.desktop
        }
    }

wincmd

    Plugin {
        type = wincmd
        Config {
            image = string
            Button1 = string
            Button2 = string
            Toggle = string
        }
    }

space

    Plugin {
        type = space
        expand = integer
        Config {
            Size = integer
        }
    }

pager

    Plugin {
        type = pager
    }

batt

    Plugin {
        type = batt
        Config {
            BatteryNumber = integer
            HideIfNoBattery = boolean
            ShowExtendedInformation = boolean
            AlarmCommand = string
            AlarmTime = integer
            BorderWidth = integer
            Size = integer
            BackgroundColor = string
            ChargingColor1 = string
            ChargingColor2 = string
            DischargingColor1 = string
            DischargingColor2 = string
        }
    }

kbled

    Plugin {
        type = kbled
        Config {
            ShowCapsLock = integer
            ShowNumLock = integer
            ShowScrollLock = integer
        }
    }

dclock

    Plugin {
        type = dclock
        Config {
            ClockFmt = string
            TooltipFmt = string
            Action = string
            BoldFont = boolean
            IconOnly = boolean
            CenterText = boolean
        }
    }

cpu

    Plugin {
        type = cpu
    }

cpufreq

    Plugin {
        type = cpufreq
    }

monitors

    Plugin {
        type = monitors
        Config {
            DisplayCPU = integer
            DisplayRAM = integer
            Action = string
            CPUColor = string
            RAMColor = string
        }
    }

thermal

    Plugin {
        type = thermal
        Config {
            NormalColor = string
            Warning1Color = string
            Warning2Color = string
            Sensor = string
            AutomaticLevels = integer
            Warning1Temp = integer
            Warning2Temp = integer
            AutomaticSensor = integer
        }
    }

deskno

    Plugin {
        type = deskno
        Config {
            BoldFont = integer
            WMLabels = integer
        }
    }

netstatus

    Plugin {
        type = netstatus
        Config {
            iface = string
            configtool = string
        }
    }

xkb

    Plugin {
        type = xkb
        Config {
            DisplayType = integer
            PerWinLayout = boolean
            NoResetOpt = = boolean
            KeepSysLayouts = boolean
            Model = string
            LayoutsList = string
            VariantsList = string
            ToggleOpt = string
            AdvancedOpt = string
            FlagSize = integer
        }
    }

volume

    Plugin {
        type = volume
        Config {
            MixerCommand = string
            MixerCommandTerm = boolean
            UseAlsamixerVolumeMapping = integer
            CardNumber = integer
            MasterChannel = string
            MuteButton = string
            SliderButton = string
            MixerButton = string
            VolumeUpKey = string
            VolumeDownKey = string
            VolumeMuteKey = string
        }
    }

weather

    Plugin {
        type = weather
        Config {
            alias = string
            city = string
            state = string
            country = string
            woeid = string
            units = string
            interval = integer
            enabled = integer
        }
    }

Configuration files

~/.config/lxpanel/"profile-name"/panels/panel
    User specific panel specification. The name of the profile is passed to lxpanel using the switch '--profile'. If none specified then name "default" will be used.

/etc/xdg/lxpanel/"profile-name"/panels/panel
    System default panel specification if no panels are defined in user configuration directory.

See also
lxpanel(1), lxpanelctl(1)

Bugs
There ought to be some. Do point them out! The Debian package maintainer will take necessary steps and actions.

Author
This text was compiled for Debian GNU/Linux by Mats Erik Andersson. It may be used also by others, but the text underlies the same licensing as lxpanel itself does.