Index - Augeas Documentation

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

S
	schedule, Cron
	screen, Xorg
	section, Xorg
	section_entry, Xorg
	section_re, Xorg
	SECTIONS, Xorg
	secton_re_obsolete, Xorg
	sep, IniFile
	Sep
	sep_col, Sudoers
	sep_com, Sudoers
	sep_cont, Sudoers
	sep_cont_opt, Sudoers
	sep_default, IniFile
	sep_dquote Sudoers Xorg
	sep_eq Cron Sudoers
	sep_re, IniFile
	sep_spc Cron Sudoers Xorg
	Separators Cron IniFile Services Sudoers Xorg
	service_attr, Xinetd
	Services
	shellvar, Cron
	spec, Sudoers
	spec_list, Sudoers
	Split, Util
	Sshd
	stdexcl, Util
	sto_integer, Sudoers
	sto_to_com, Sudoers
	sto_to_com_cmnd, Sudoers
	sto_to_com_col, Sudoers
	sto_to_com_user, Sudoers
	sto_to_comment, IniFile
	sto_to_eol, IniFile
	sto_to_eq, Sudoers
	sto_to_spc, Sudoers
	sto_to_spc_no_dquote, Sudoers
	Stores IniFile Sudoers
	Sudoers
T
	tag_spec, Sudoers
	the valid values for schedules, Cron
	time, Cron
	title, IniFile
	Title definition, IniFile
	title_label, IniFile
	to_eol, Xorg
	TODO, IniFile
U
	Usage Example Dpkg Exports
	USEFUL PRIMITIVES Cron IniFile Services Sudoers Xorg
	user, Cron
	USER SPECIFICATION, Sudoers
	user_alias, Sudoers
	Util
V
	videoram, Xorg
X
	Xinetd
	Xorg

let schedule = [ label "schedule" . Util.del_str "@" . store schedule_re ]

Time in the format “@keyword”

let screen = [ indent . del /[sS]creen/ "Screen" . label "Screen" . sep_spc . [ label "num" . store int . sep_spc ]? . quoted_string_val . sep_spc . [ label "position" . store to_eol ] . eol ]

The Screen entry of ServerLayout

let section = [ indent . del "Section" "Section" . sep_spc . sep_dquote . key (section_re|section_re_obsolete) . sep_dquote . eol . section_entry* . indent . del "EndSection" "EndSection" . eol ]

A section in xorg.conf

let section_entry = option | screen | display | input_device | driver | identifier | videoram | default_depth | device | entry_generic | empty | comment

let section_re = /(
Files|ServerFlags|Module|InputDevice|Device|VideoAdaptor|Monitor|Modes|Screen|ServerLayout|DRI|Vendor
)/

Known values for Section names

The following obsolete section names are still recognised for compatibility purposes.

let sep ( pat:regexp ) (default:string) = Util.del_opt_ws "" . del pat default

Generic separator

Generic separators to build lenses

let sep_col = sep_cont_opt . Util.del_str ":" . sep_cont_opt

let sep_com = sep_cont_opt . Util.del_str "," . sep_cont_opt

let sep_cont = del /( [ \t]+|[ \t]*\\\\\n[ \t]* )/ " "

let sep_cont_opt = del /( [ \t]*|[ \t]*\\\\\n[ \t]* )/ " "

let sep_default = "="

The default separator value

let sep_dquote = Util.del_str "\""

let sep_eq = Util.del_str "="

let sep_eq = sep_cont_opt . Util.del_str "=" . sep_cont_opt

let sep_re = /[=:]/

The default regexp for a separator

let sep_spc = Util.del_ws_spc

let sep_spc = del /[ \t]+/ " "

let sep_spc = Util.del_ws_spc

let service_attr = attr_one (
"socket_type" | "protocol" | "wait" | "user" | "group" |"server" | "instances" | "rpc_version" | "rpc_number" | "id" | "port" | "nice" | "banner" | "bind" | "interface" | "per_source" | "groups" | "banner_success" | "banner_fail" | "disable" | "max_load" | "rlimit_as" | "rlimit_cpu" | "rlimit_data" | "rlimit_rss" | "rlimit_stack" | "v6only" | "deny_time" | "umask" | "mdns" | "libwrap"
)

It is much faster to combine, for example, all the attr_one attributes into one regexp and pass that to a lens instead of using lens union (attr_one “a” | attr_one “b”|..)

Parses /etc/services

let shellvar = [ key /[A-Z][A-Za-z0-9]*/ . sep_eq . Shellvars.simple_value . eol ]

A shell variable in crontab

let spec = [ label "spec" . indent . alias_list "user" sto_to_com_user . sep_cont . spec_list . ( sep_col . spec_list )* . eol ]

A user specification, listing colon-separated spec_lists

let spec_list = [ label "host_group" . alias_list "host" sto_to_com . sep_eq . cmnd_spec_list ]

Group of hosts with cmnd_spec_list

Parses /etc/ssh/sshd_config

let stdexcl = (
excl "*~"
) . (excl "*.rpmnew") . (excl "*.rpmsave") . (excl "*.augsave") . (excl "*.augnew")

Exclusion for files that are commonly not wanted/needed

let sto_integer = store /[0-9]+/

let sto_to_com = store /(
[^,=:#() \t\n\\\\][^,=:#()\n]*[^,=:#() \t\n\\\\]
)|[^,=:#() \t\n\\\\]/

There could be a \ in the middle of a command

let sto_to_com_cmnd = store /(
[^,=:#() \t\n\\\\][^,=:#()\n]*[^,=:#() \t\n\\\\]
)|[^,=:#() \t\n\\\\]/

sto_to_com_cmnd does not begin or end with a space

let sto_to_com_col = store /[^",=#() \t\n\\\\]+/ (* " relax emacs *)

let sto_to_com_user = store (
/[^,=:#() \t\n]+/ - /(User|Runas|Host|Cmnd)_Alias|Defaults.*/
)

let sto_to_comment = Util.del_opt_ws "" . store /[^;# \t\n][^;#\n]*[^;# \t\n]|[^;# \t\n]/

Store until comment

let sto_to_eol = Util.del_opt_ws "" . store /( [^ \t\n].*[^ \t\n]|[^ \t\n] )/

Store until end of line

let sto_to_eq = store /[^,=:#() \t\n\\\\]+/

let sto_to_spc = store /[^", \t\n\\\\]+|"[^", \t\n\\\\]+"/

let sto_to_spc_no_dquote = store /[^", \t\n\\\\]+/ (* " relax emacs *)

Parses /etc/sudoers

let tag_spec = [ label "tag" . store /(NO)?(PASSWD|EXEC|SETENV)/ . sep_col ]

Tag specification for spec

let time = [ label "time" . minute . sep_spc . hour . sep_spc . dayofmonth . sep_spc . month . sep_spc . dayofweek ]

Time in the format “minute hour dayofmonth month dayofweek”

let title ( kw:regexp ) = Util.del_str "[" . key kw . Util.del_str "]". eol

Title for record.

let title_label (
name:string
) (kw:regexp) = label name . Util.del_str "[" . store kw . Util.del_str "]". eol

Title for record.

let to_eol = /[^ \t\n]( .*[^ \t\n] )?/

Match everything from here to eol, cropping whitespace at both ends

Things to add in the future

let user = [ label "user" . store Rx.word ]

let user_alias = alias_entry "User_Alias" "user" sto_to_com

User_Alias, see alias_field

Generic module providing useful primitives

let videoram = entry_int "VideoRam" /[vV]ideo[rR]am/

Parses xinetd configuration files

Parses /etc/X11/xorg.conf