Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[doc] Rewrite type details 

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Julien Danjou 2008-04-08 08:28:37 +02:00
parent 03e754e04a
commit 6b19c3e246
1 changed files with 19 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
build-utils/extractrcskeleton.py
View File

@ -1,6 +1,7 @@
#!/usr/bin/env python #!/usr/bin/env python
# #
# extractuicbdoc.py - extract uicb documentation from awesome source code # extractuicbdoc.py - extract uicb documentation from awesome source code
# Copyright (C) 2008 Julien Danjou <julien@danjou.info>
# Copyright (C) 2008 Marco Candrian <mac@calmar.ws> # Copyright (C) 2008 Marco Candrian <mac@calmar.ws>
# #
# This indeed crappy. Any better version, even with awk, would be welcome. # This indeed crappy. Any better version, even with awk, would be welcome.
@ -8,32 +9,25 @@
print """Note: when there is no whitespace, quotes are optional. print """Note: when there is no whitespace, quotes are optional.
<boolean> -> "true" or "false" <boolean> -> true or false
<color> -> #ff9933 (hexadecimal color notation: #red green blue) <color> -> Color in X format or hexadecimal (e.g. #aabbcc)
<float> -> 0.3, 0,8 (often values between 0 and 1 are useful) <float> -> Floating numbers (e.g 0.2)
<font> -> Pango font: sans 10, sans italic 10, fixed 12, ... <font> -> Pango font: [FAMILY-LIST] [STYLE-OPTIONS] [SIZE] (e.g Sans Italic 12)
<identifier> -> foobar (choose a name/string) <identifier> -> A name used to identify (e.g foobar)
<image> -> "/home/awesome/pics/icon.png" (path to image) <image> -> A path to an image (e.g. /home/user/image.jpg)
<integer> -> 1, 10, -3 (positive numbers are required mostly) <integer> -> A signed integer
<key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev') <key> -> A KeySym (e.g. F10) or a KeyCodea (e.g #120)
or a keycode beginning with # <mod> -> A key modifier list (e.g. Mod1)
<mod> -> "Mod1", "Mod4", "Control" (modifiers) <regex> -> Regular expression
<regex> -> regular expression <string> -> A string
<string> -> "foo bar" <uicb-arg> -> Argument to an uicb function
<uicb-arg> -> prog, 3... (argument to a uicb function, where required) <uicb-cmd> -> Uicb function, see UICB FUNCTIONS
<uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above) <position> -> A position: off, top, right, left, bottom, auto
<position> -> list of position: off, top, right, left, bottom, auto <style section> -> A style section
<style section> -> a section with font, fg, bg, border, shadow and shadow_offset options. <titlebar sec> -> A titlebar section
{ font = <font> fg = <color> bg = <color> border = <color> <{.., ...}> -> List of available options
shadow = <color> shadow_offset = <integer> } [MULTI] -> This item can be defines multiple times
<titlebar sec> -> a section with position and icon position.
{ position = <position> icon = <position> text_align = <{center,right,left}>
height = <integer> width = <integer> styles { } }
<{.., ...}> -> list of available options
[MULTI] means, you can use an item multiple times.
""" """
#<layout> -> dwindle, floating, max, spiral, tile, tileleft, tilebottom, tiletop
import sys import sys