buffyboard.conf

package: buffyboard

title: buffyboard.conf(5)

text:
# buffyboard.conf(5)

## NAME
BUFFYBOARD - configuration file

## DESCRIPTION
BUFFYBOARD expects a configuration file with options in the following format, with one option/value pair per line:

```
[section]
<option>=<value>
```

On launch, BUFFYBOARD searches for configuration files in various locations and successively merges all files together into a single configuration. Files are searched for and, if found, merged in the following order:

- /usr/share/buffyboard/buffyboard.conf

- /usr/share/buffyboard/buffyboard.conf.d/ (alphabetically)

- /etc/buffyboard.conf

- /etc/buffyboard.conf.d/ (alphabetically)

- Override files (in supplied order)

## OPTIONS

### Theme
default = <adwaita-light|adwaita-dark|breezy-light|breezy-dark|nord-light|nord-dark|pmos-light|pmos-dark>

Selects the default theme on boot. Can be changed at runtime to the alternative theme. Default: breezy-dark.

### Input
pointer = <true|false>

Enable or disable the use of a hardware mouse or other pointing device. Default: true.

touchscreen = <true|false>

Enable or disable the use of the touchscreen. Default: true.

### Quirks
fbdev_force_refresh = <true|false>

If true and using the framebuffer backend, this triggers a display refresh after every draw operation. This has a negative performance impact. Default: false.

## SEE ALSO
buffyboard(1)

## AUTHORS
Undef <debian@undef.tools> Johannes Marbach <n0-0ne@mailbox.org>

branch: sisyphus


bup-config

package: bup-web

title: bup-config(5)

summary: bup configuration options

text:
# bup-config(5)

## NAME
bup-config - bup configuration options

## DESCRIPTION
The following options may be set in the relevant git config (git-config(1)).

## OPTIONS
pack.packSizeLimit

Respected when writing pack files (e.g. via bup save ...). Currently read from the repository to which the pack files are being written, excepting bup on REMOTE... which incorrectly reads the value from the REMOTE repository.

## SEE ALSO
git-config(1)

## BUP
Part of the bup(1) suite.

## AUTHORS
Rob Browning rlb@defaultvalue.org.


bzw

package: bzflag

title: bzw(5)

summary: BZFlag world file format

text:
# bzw(5)

## NAME
bzw - BZFlag world file format

## DESCRIPTION
The BZFlag world file format describes a world environment that is used by the BZFlag game server, bzfs. X BZW file format

The BZFlag world file format describes and environment that includes the game map, physical world attributes, and automatic world weapons. The map may contain a variety of "obstacles" like buildings, pyramids, and meshes. These obstacles make up the world that the BZFlag tanks will drive around in. Map attributes may be set to create worlds of various sizes, the default size is 800x800.

Here is small example world:

\# simple world containing a box, pyramid, and mesh

world

name Simple World

size 100.0

end

box

position -20 -20 0

size 10 20 10

end

pyramid

position 20 20 0

size 10 10 20

end

mesh

vertex -10 0 0

vertex 10 0 0

vertex 0 10 0

face

vertices 0 1 2

endface

end

The .bzw file is a plain text file with a relatively simple file format. The format of this text file consists of any number of objects listed in any order (except that physics, textureMatrix, dynamicColor, and material must come before they are referenced) separated by newlines and grouped into blocks of types. The list of world types consists of:

world

options

waterLevel

dynamicColor

textureMatrix

transform

material

physics

define

group

mesh

meshbox

meshpyr

arc

cone

sphere

tetra

box

pyramid

link

teleporter

base

weapon

zone

Each object is described by placing the type on one line, the word end on a following line, and a list of attributes for that object, one per line, in between. The exceptions to the rule are define and face, which are concluded with enddef and endface. Attributes may be listed in any order. Attributes have default values, and if that is good enough, the attribute need not be listed.

Words are always specified in lowercase. Line comments can be specified by placing a # sign at the start of the line.

For documentation purposes, you can tag each object by adding a name attribute. There is no set limit to the number of times you may use any of the objects except for the world, options, and waterLevel objects, they can only be specified once. The options object contains command line arguments that are used to configure the server's game mode, but can not contain server specific options such as -p, -passwd, and -conf.

In the following examples, the values are the defaults.

The World object

Header for the world.

world

name example_world

size 400.0

flagHeight 10.0

end

The Options object

A world file interface for setting command line options for BZFS.

options

-set _tankSpeed 36

-j +r -ms 3

+f GM{5} +f SW{5}

end

The Water Level object

Sets how high the water is, in a matter of units.

waterLevel

name example_waterlevel

height -1.0 # anything below 0 turns it off

end

The Group Definition object

Defines a group, which may include other group instances

This does not place any objects into the world, a group instance must be used to generate world objects from a group definition.

define <example_groupdef>

\# You can add any object to a group definition,

\# except for the following types:

\# textureMatrix

\# dynamicColor

\# material

\# physics

\# links

\# weapon

\# zone

enddef

The Group Instantiation object

Instantiates a group, and possibly modifies subobjects

group <example_groupdef> # a valid group definition reference

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

\# angle degrees about vector n

team 0 # change all base colors within group

tint 1 1 1 1 # hierarchically tints objects within this group

drivethrough # make all subobjects drivethrough

shootthrough # make all subobjects shootthrough

ricochet # make all subobjects ricochet phydrv example_phydrv # reassign any valid physics drivers

matref example_material # set material properties

\# (except for the color)

matswap oldMat newMat #replace a given material in the instance

end

The Dynamic Color object

dynamicColor

name example_dyncol

\# there are 4 channels that can be modified:

\# red, green, blue, alpha

\# there are 5 types of commands per channel:

\# limits, sinusoid, clampUp, clampDown, sequence

\# except for "limits" and "sequence", the commands are repeatable

\# if a sequence is used, then clampUps and clampDowns have no effect

\# sequences can use three states (0, 1, 2).

\# 0 - equivalent to an active clampDown

\# 1 - equivalent to no clamps

\# 2 - equivalent to an active clampUp

\# if both clampUp and clampDown are active, the value is (min+max)/2

\# the sinusoid function starts at the max value

\# the sum of a channel's sinusoids is clamped between 0 and 1

red limits 0 1 # min/max limits

green sinusoid 0.1 0 0.25 # period, offset, weight

blue clampUp 0.1 0 0.75 # period, offset, width

alpha clampDown 0.2 0.5 0.5 # period, offset, width

red sequence 0.0 0.0 2 0 1 1 2 0 ... # period, offset, list of states

end

The Texture Matrix object

textureMatrix

name example_texmat

scale 0.0 0.0 1.0 1.0 # u/v freqs, u/v scales

spin 0.0 # rotation freq

shift 0.0 0.0 # u/v freqs

center 0.5 0.5 # dynamic u/v center (for spin and scale)

fixedscale 0.0 0.0 # time invariant u/v scale

fixedspin 0.0 # time invariant rotation

fixedshift 0.0 0.0 # time invariant u/v shift

end

Material Properties

Material properties may be set on several types of objects, including meshes, mesh faces, arcs, cones, spheres, and tetras. Here are the properties:

material

name example_material

resetmat # restore default values

matref material_name # copy another material's properties

ambient 0.2 0.2 0.2 1.0 # ambient color

diffuse 1.0 1.0 1.0 1.0 # diffuse color (main color)

color 1.0 1.0 1.0 1.0 # synonym for 'diffuse'

specular 0.0 0.0 0.0 1.0 # specular color

emission 0.0 0.0 0.0 1.0 # emission color

shininess 0.0 # shininess (0.0 – 128.0)

texture filename # set working texture

\# - non-interlaced PNG

\# - http:// or ftp:// hyperlinks can be used (no spaces)

\# - BZFlag default texture names can be used (.png not required)

addtexture filename # add texture

notextures # specify that no textures are to be used

notexalpha # don't use the texture's alpha channel

notexcolor # the color is not applied to the texture

\# if a texture is specified, but not found, the default texture

\# will be used. if the default texture is also not available, then

\# the color will be used (untextured)

spheremap # use spherical texture coordinate mapping

texmat -1 # texture matrix (-1 for none)

dyncol -1 # dynamic color (-1 for none)

noradar # do not display on radar (except normal mode)

noshadow # do not render shadows

noculling # do not cull by face winding (double-sided)

nosorting # do not do front-to-back alpha sorting

nolighting # disable lighting

alphathresh 0.0 # alpha thresholding value

groupalpha # sort translucent faces as a group

occluder # faces with this material will occlude

end

The Physics Driver object

physics

name example_phydrv

linear 0.0 0.0 0.0 # x/y/z linear velocities

angular 0.0 0.0 0.0 # rotation freq, x/y coordinates

slide 0.0 # time until max velocity (> 0.0 enables)

death Message goes here.

\# the 'death' property requires a non-blank message

end

The Mesh object

mesh

name example_mesh

\# Material properties applied to a mesh apply to all faces

\# that follow the setting. Mesh faces will alter their own

\# properties without affecting the state of the mesh properties.

\# The same pattern is used to apply physics drivers.

vertex 100 200 300 # add a vertex (repeatable)

normal 1.0 0 0 # add a normal (repeatable)

texcoord 0.1 0.75 # add a texture coordinate (repeatable)

inside 5.5 4.5 1.2 # add an inside point (repeatable)

outside 0 0 1000 # add an outside point (repeatable)

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

phydrv example_phydrv # assign a physics driver

smoothbounce # ricochets use normals

noclusters # render each mesh face individually

face # start a face (repeatable)

\# the front-face winding is counter-clockwise

vertices 1 4 0 3 5 # list of vertices (requires at least three)

normals 2 6 0 4 7 # list of normals (optional)

texcoords 0 3 2 4 9 # list of texture coordinates (optional)

phydrv example_phydrv # assign a physics driver

endface # end the face

\#

\# This next element can be added to increase the rendering speed

\# of the mesh object. If the client is capable of using this data,

\# then it is used to draw the mesh instead of the face information.

\#

drawInfo

dlist # display list for all material sets

decorative # older clients with not see this mesh

angvel <degrees/sec> # rotation about initial Z axis

extents <minX> <minY> <minZ> <maxX> <maxY> <maxZ>

sphere <x> <y> <z> <radiusSquared>

corner <v> <n> <t> (repeatable)

vertex 0.0 0.0 0.0 (repeatable)

normal 0.0 0.0 0.0 (repeatable)

texcoord 0.0 0.0 (repeatable)

lod (repeatable)

lengthPerPixel <value>

matref <name> (repeatable)

dlist # display list for this material set

sphere <x> <y> <z> <radiusSquared>

points 0 (repeatable)

lines 0 1 (repeatable)

lineloop 0 1 (repeatable)

linestrip 0 1 (repeatable)

tris 0 1 2 (repeatable)

tristrip 0 1 2 (repeatable)

trifan 0 1 2 (repeatable)

quads 0 1 2 3 (repeatable)

quadstrip 0 1 2 3 (repeatable)

polygon 0 1 2 (repeatable)

end # matref

end # lod

end # drawInfo

end # mesh

The Arc object

arc

name example_arc

divisions 16 # number of subdivisions

flatshading # flat shading (smooth is default)

angle 360 # the sweep angle

ratio 1 # (outrad - inrad) / outrad

position 0.0 0.0 0.0

size 10 10 10

rotation 0.0

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

phydrv example_phydrv # assign a physics driver

smoothbounce # ricochets use normals

end

The Cone object

cone

name example_cone

divisions 16 # number of subdivisions

flatshading # flat shading (smooth is default)

angle 360 # the sweep angle

position 0.0 0.0 0.0

size 10 10 10

rotation 0.0

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

phydrv example_phydrv # assign a physics driver

smoothbounce # ricochets use normals

end

The Sphere object

sphere

name example_sphere

divisions 4 # number of subdivisions

flatshading # flat shading (smooth is default)

position 0.0 0.0 10.0

size 10 10 10

radius 10 # sets all size values to this value

rotation 0.0

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

phydrv example_phydrv # assign a physics driver

smoothbounce # ricochets use normals

end

The Tetrahedron object

tetra

name example_tetra

\# there must always be 4 vertices

vertex -10.0 -5.0 0.0

vertex +10.0 -5.0 0.0

vertex 0.0 10.0 0.0

vertex 0.0 5.0 10.0

shift 0 0 0 # (repeatable)

scale 1 1 1 # (repeatable)

shear 0 0 0 # (repeatable)

spin angle nx ny nz # (repeatable)

end

The Box object

Adds a simple block.

box

name example_box

position 0.0 0.0 0.0

size 30.0 30.0 9.42

rotation 0.0

end

The Pyramid object

Adds a triangular shaped object.

pyramid

name example_pyramid

position 0.0 0.0 0.0

size 8.2 8.2 10.25

rotation 0.0

end

The Teleporter object

Adds an object that places a tank at another teleporter in a different area when ran through.

teleporter [name]

\# the [name] tag is used for linkage

name example_teleporter

position 0.0 0.0 0.0

size 5.06 4.48 20.16

rotation 0.0

border 1.12

end

The Link object

Adds a route to teleport a tank between two teleporters.

\# Teleporter names are terminated with either :f (forward)

\# or :b (backwards). The forwards link points to 0 degrees,

\# and the backwards link points to 180. Links are made by

\# pattern matching the teleporter names. The '*' and '?'

\# globbing characters can be used to make multiple matches.

\# If there are multiple matches for the "to" link, then the

\# destination will be selected randomly between the matches.

\# in-game.

\# NOTE: bzfs -d -d -d -d will print the linkage table.

link

name example_link

\# this will link all teleporters randomly to all other teleporters

from *

to *

end

\# or, to link between known teleporters examp_tele1(front) and examp_tele2(back)

link

name example_realLink

from examp_tele1:f

to examp_tele2:b

end

The Base object

Creates a team base where the corresponding team's flag is stored. The oncap option will fire a world weapon of the specified type when the team flag for this base is captured.

base

name example_base

position 0.0 0.0 0.0

size 60.0 60.0 0.0

rotation 0.0

color 0

oncap V

end

The Weapon object

Creates a world weapon, or a weapon fired automatically by the world. The weapon can either be timed or be event driven. Timed weapons should use the initdelay and delay fields. Event driven weapons need to use the trigger option to define what the trigger event is. Valid trigger events are; OnCap, for flag capture events. OnSpawn, for player spawn events. OnDie, for player death events. If the weapon is to be triggered only for a specific team then the eventteam option should be used with a team number (1 to 4). An eventteam value of -1 will trigger this weapon for any team. -1 is the default eventteam value.

weapon

name example_weapon

position 0.0 0.0 0.0

rotation 0.0

tilt 0.0

initdelay 10.0

delay 10.0 3.0 5.0 3.0

type V

trigger flagcap

eventteam V

end

The Zone object

Specifies a certain range in the world, and what attributes that range has.

zone

name example_zone

position 0.0 0.0 0.0

size 1.0 1.0 1.0

rotation 0.0

\# where players may spawn

team 0 1 2 3 4

\# where flag may spawn

flag GM SW good bad

\# dropped team flags will fly to the closest safety zone

safety 1 2 3 4

\# attach a flag to this zone (always spawn in this zone)

zoneflag GM 3 # type, count (type can be a team flag, ex: R*)

end

## FILE SYNTAX
The symbol '?' means that the item is optional.

The notation {a..b} means that the number of times the item can be present must be between 'a' and 'b', where '*' mean infinity. ('?' is equivalent to {0..1})

angle := <float>

2dpoint := <float> <float>

3dpoint := <float> <float> <float>

rgbColor := <float> <float> <float>

alpha := <float>

rgbaColor := rgbColor alpha? | <color_name> alpha?

channel := "red" | "green" | "blue" | "alpha"

(BZWReader.cxx/parseNormalObject)

allObjects :=

"box"

| "pyramid"

| "base"

| "link"

| "teleporter"

| "mesh"

| "arc"

| "meshbox"

| "cone"

| "meshpyr"

| "sphere"

| "tetra"

| "weapon"

| "zone"

| "waterLevel"

| "dynamicColor"

| "textureMatrix"

| "material"

| "physics"

| "transform"

(BZWReader.cxx/BZWReader::readWorldStream)

Note: Blank lines and lines starting with # are discarded.

worldStream :=

"end"

| allObjects

| "define" <group_name>

| "enddef"

| "group" <group_name>

| "teleporter" <name>?

| "options"

| "include" <filename>

| "world"

(ParseMaterial.cxx/parseMaterials)

material :=

object

| "matref" <material_name>

| "resetmat"

| "dyncol" <dynamic_color_name>

| "ambient" rgbaColor

| ("diffuse" | "color") rgbaColor

| "specular" rgbaColor

| "emission" rgbaColor

| "shininess" <float>

| "texture <texture_name>

| "notextures"

| "addtexture" <texture_name>

| "texmat" <matrix_name>

| "notexalpha"

| "notexcolor"

| "spheremap"

| "noradar"

| "noshadow"

| "noculling"

| "nosorting"

| "nolighting"

| "alphathresh" <value>

| "groupalpha"

| "occluder"

| "shader" <shader_name> # NOT IMPLEMENTED

| "addshader" <shader_name> # NOT IMPLEMENTED

| "noshaders" # NOT IMPLEMENTED

(WorldFileObject:.cxx/WorldFileObject::read)

object := "name" <name>

(WorldFileLocation.cxx/readWorldFileLocation::read)

location :=

("pos" | "position") 3dpoint

| "size" 3dpoint

| ("rot" | "rotation") <float>

| "shift" 3dpoint

| "scale" 3dpoint

| "shear" 3dpoint

| "spin" angle 3dpoint

| "xform" <transform_name>

| object

(WorldFileObstacle.cxx/WorldFileObstacle::read)

obstacle :=

"drivethrough"

| "shootthrough"

| "passable"

| "ricochet"

| location

(CustomArc.cxx/CustomArc::read)

meshbox :=

"divisions" <integer>

| "angle" angle

| "ratio" <float>

| "texsize" <float> <float> <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "flatshading"

| material

| ("top" | "bottom" | "inside" | "outside" | "startside" | "endside") material

| obstacle

arc :=

"divisions" <integer>

| "angle" angle

| "ratio" <float>

| "texsize" <float> <float> <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "flatshading"

| material

| ("top" | "bottom" | "inside" | "outside" | "startside" | "endside") material

| obstacle

(CustomBase.cxx/CustomBase::read)

base :=

"color" <integer>

| obstacle

(CustomBox.cxx)

box := obstacle

(CustomCone.cxx/CustomCone::read)

meshpyr :=

"divisions" <integer>

| "angle" <float>

| "texsize" <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "flatshading"

| material

| ("edge" | "bottom" | "startside" | "endside") material

| "flipz"

| obstacle

cone :=

"divisions" <integer>

| "angle" <float>

| "texsize" <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "flatshading"

| material

| ("edge" | "bottom" | "startside" | "endside") material

| obstacle

(CustomDynamicColor.cxx/CustomDynamicColor::read)

dynamicColor :=

object

| channel "limits" <float> <float>

| channel "sinusoid" <float> <float> <float>

| channel "clampup" <float> <float> <float>

| channel "clampdown" <float> <float> <float>

| channel "sequence" <float> <float> ("0" "1" "2"){1..*}

(CustomGate.cxx/CustomGate::read)

teleporter :=

"border" <float>

| "horizontal" # NOT IMPLEMENTED

| obstacle

(CustomGroup.cxx/CustomGroup::read)

group :=

"team" <integer>

| "tint" rgbaColor

| "phydrv" <physics_driver_name>

| "matref" <material_name>

| obstacle

(CustomLink.cxx/CustomLink::read)

teleporter_spec :=

<integer>

| <teleporter_name_with_wildcards> (":f" | ":b")?

link :=

"from" <teleporter_spec>

| "to" <teleporter_spec>

| object

(MeshDrawInfo.cxx/MeshDrawInfo::parseDrawCmd)

drawInfoCmd :=

"points" <integer>+

| "lines" <integer> <integer> <integer>{2}*

| "lineloop" <integer> <integer>+

| "linestrip" <integer> <integer> <integer{2}*

| "tris" <integer> <integer> <integer> <integer>{3}*

| "tristrip" <integer> <integer> <integer>+

| "trifan" <integer> <integer> <integer>+

| "quads" <integer> <integer> <integer> <integer> <integer>{4}*

| "quadstrip" <integer> <integer> <integer>{2}+

| "polygon" <integer> <integer> <integer> <integer>{3}*

(MeshDrawInfo.cxx/MeshDrawInfo::parseDrawSet)

drawInfoSet :=

"matref" <material_name>

| "dlist"

| "sphere" 3dpoint <float>

| drawInfoCmd

(MeshDrawInfo.cxx/MeshDrawInfo::parseDrawLod)

drawInfoLod :=

"lod"

| "lengthPerPixel" <float>

| drawInfoSet

(MeshDrawInfo.cxx/MeshDrawInfo::parse)

drawInfo :=

"drawInfo"

| "dlist"

| "decorative"

| "angvel" <float>

| "extents" 3dpoint 3dpoint

| "sphere" 3dpoint <float>

| "corner" <integer> <integer> <integer>

| "vertex" 3dpoint

| "normal" 3dpoint

| "texcoord" <float> <float>

| drawInfoLod

(CustomMesh.cxx/CustomMesh::read)

mesh :=

"face"

| face

| "endface"

| "inside" 3dpoint

| "outside" 3dpoint

| "vertex" 3dpoint

| "normal" 3dpoint

| "texcoord" <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "noclusters"

| drawInfo

| material

| obstacle

(CustomMeshFace.cxx/CustomMeshFace::read)

face :=

"vertices" <integer>{3..*}

| "normals" <integer>{3..*}

| "texcoords" <integer>{3..*}

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "noclusters"

| "drivethrough"

| "shootthrough"

| "ricochet"

| "passable"

| material

(CustomMeshTransform.cxx/CustomMeshTransform::read)

transform :=

"shift" 3dpoint

| "scale" 3dpoint

| "shear" 3dpoint

| "spin" angle 3dpoint

| "xform" <transform_name>

| object

(CustomPhysicsDriver.cxx/CustomPhysicsDriver::read)

physics :=

"linear" 3dpoint

| "angular" <float> 2dpoint

| "radial" <float> 2dpoint # NOT IMPLEMENTED

| "slide" <float>

| "death" <string>

| object

(CustomPyramid.cxx/CustomPyramid::read)

pyramid :=

"flipz"

| obstacle

(CustomSphere.cxx/CustomSphere::read)

sphere :=

"divisions" <integer>

| "radius" <float>

| ("hemi" | "hemisphere")

| "texsize" <float> <float>

| "phydrv" <physics_driver_name>

| "smoothbounce"

| "flatshading"

| material

| ("edge" | "bottom") material

| obstacle

(CustomTetra.cxx/CustomTetra::read)

Note: At most 4 vertices can be specified.

Note2: material will apply to all vertices when specified first, otherwise like "normals" and "texcoords" they apply to the previous vertex.

tetra :=

"vertex" 3dpoint

| "normals" 3dpoint

| "texcoords" 2dpoint

| material

| obstacle

(CustomTextureMatrix.cxx/CustomTextureMatrix::read)

textureMatrix :=

"fixedshift" 2dpoint

| "fixedscale" 2dpoint

| "fixedspin" angle

| "fixedcenter" 2dpoint

| "shift" <float> <float>

| "spin" <float>

| "scale" <float> <float> <float> <float>

| "center" 2dpoint

| object

(CustomWaterLevel.cxx/CustomWaterLevel::read)

waterLevel :=

"height" <float>

| material

| object

(CustomWeapon.cxx/CustomWeapon::read)

weapon :=

"initdelay" <float>

| "delay" <float>{1..*}

| "type" <flag_short_name>

| location

(CustomWorld.cxx/CustomWorld::read)

world :=

"size" <float>

| "flagHeight" <float>

| object

(CustomZone.cxx/CustomZone::read)

zone :=

"team" <integer>{1..*}

"flag" ("good" | "bad" | <flag_short_name>){1..*}

| "safety" <integer>{1..*}

| "zoneflag" <flag_short_name> <integer>?

| location

## SEE ALSO
bzflag(6), bzadmin(6), bzfs(6)


cachefilesd.conf

package: cachefilesd

title: cachefilesd.conf(5)

summary: Local file caching configuration file

text:
# cachefilesd.conf(5)

## NAME
/etc/cachefilesd.conf - Local file caching configuration file

## SYNOPSIS
The configuration file for cachefilesd which can manage a persistent cache for a variety of network filesystems using a set of files on an already mounted filesystem as the data store.

## DESCRIPTION
This configuration file can contain a number of commands. Each one should be on a separate line. Blank lines and lines beginning with a '#' character are considered to be comments and are discarded.

The only mandatory command is:

dir <path>

This command specifies the directory containing the root of the cache. It may only specified once per configuration file.

All the other commands are optional:

secctx <label>

Specify an LSM security context as which the kernel will perform operations to access the cache. The default is to use cachefilesd's security context. Files will be created in the cache with the label of directory specified to the 'dir' command.

brun <N>%

bcull <N>%

bstop <N>%

frun <N>%

fcull <N>%

fstop <N>%

These commands configure the culling limits. The defaults are 7% (run), 5% (cull) and 1% (stop) respectively. See the section on cache culling for more information.

The commands beginning with a 'b' are file space (block) limits, those beginning with an 'f' are file count limits.

tag <name>

This command specifies a tag to FS-Cache to use in distinguishing multiple caches. This is only required if more than one cache is going to be used. The default is "CacheFiles".

culltable <log2size>

This command specifies the size of the tables holding the lists of cullable objects in the cache. The bigger the number, the faster and more smoothly that culling can proceed when there are many objects in the cache, but the more memory will be consumed by cachefilesd.

The quantity is specified as log2 of the size actually required, for example 12 indicates a table of 4096 entries and 13 indicates 8192 entries. The permissible values are between 12 and 20, the latter indicating 1048576 entries. The default is 12.

nocull

Disable culling. Culling and building up the cull table take up a certain amount of a systems resources, which may be undesirable. Supplying this option disables all culling activity. The cache will keep building up to the limits set and won't be shrunk, except by the removal of out-dated cache files.

resume_thresholds <blocks> <files>

This command specifies the amount of blocks or files that the kernel should let go of before the daemon should resume from culling table scan suspension.

Scanning to refill the cull table is suspended when all the objects in a cache are pinned by a live network filesystem in the kernel and there's nothing to cull.

Either value can be "-" to indicate that this threshold should be ignored.

debug <mask>

This command specifies a numeric bitmask to control debugging in the kernel module. The default is zero (all off). The following values can be OR'd into the mask to collect various information:

1

Turn on trace of function entry (_enter() macros)

2

Turn on trace of function exit (_leave() macros)

4

Turn on trace of internal debug points (_debug())

This mask can also be set through /sys/module/cachefiles/parameters/debug.

## EXAMPLES
As an example, consider the following:

dir /var/cache/fscache

secctx cachefiles_kernel_t

tag mycache

brun 10%

bcull 7%

bstop 3%

secctx system_u:system_r:cachefiles_kernel_t:s0

This places the cache storage objects in a directory called "/var/cache/fscache", names the cache "mycache", permits the cache to run freely as long as there's at least 10% free space on /var/cache/fscache/, starts culling the cache when the free space drops below 7% and stops writing new stuff into the cache if the amount of free space drops below 3%. If the cache is suspended, it won't reactivate until the amount of free space rises again to 10% or better.

Furthermore, this will tell the kernel module the security context it should use when accessing the cache (SELinux is assumed to be the LSM in this example). In this case, SELinux would use cachefiles_kernel_t as the key into the policy.

## CACHE CULLING
The cache may need culling occasionally to make space. This involves discarding objects from the cache that have been used less recently than anything else. Culling is based on the access time of data objects. Empty directories are culled if not in use.

Cache culling is done on the basis of the percentage of blocks and the percentage of files available in the underlying filesystem. There are six "limits":

brun

frun

If the amount of free space and the number of available files in the cache rises above both these limits, then culling is turned off.

bcull

fcull

If the amount of available space or the number of available files in the cache falls below either of these limits, then culling is started.

bstop

fstop

If the amount of available space or the number of available files in the cache falls below either of these limits, then no further allocation of disk space or files is permitted until culling has raised things above these limits again.

These must be configured thusly:

0 <= bstop < bcull < brun < 100

0 <= fstop < fcull < frun < 100

Note that these are percentages of available space and available files, and do not appear as 100 minus the percentage displayed by the df program.

The userspace daemon scans the cache to build up a table of cullable objects. These are then culled in least recently used order. A new scan of the cache is started as soon as space is made in the table. Objects will be skipped if their atimes have changed or if the kernel module says it is still using them.

Culling can be disabled with the nocull option.

## SEE ALSO
cachefilesd(8), df(1), /usr/share/doc/cachefilesd/README

## AUTHORS
David Howells <dhowells@redhat.com>


certmonger.conf

package: certmonger

title: certmonger.conf(5)

summary: configuration file for certmonger

text:
# certmonger.conf(5)

## NAME
certmonger.conf - configuration file for certmonger

## DESCRIPTION
The certmonger.conf file contains default settings used by certmonger. Its format is more or less that of a typical INI-style file. The only sections currently of note are named defaults and selfsign.

## DEFAULTS
Within the defaults section, these variables and values are recognized:

notify_ttls

This is the list of times, given in seconds, before a certificate's not-after validity date (often referred to as its expiration time) when certmonger should warn that the certificate will soon no longer be valid. If this value is not specified, certmonger will attempt to use the value of the ttls setting. The default list of values is "2419200, 604800, 259200, 172800, 86400, 43200, 21600, 7200, 3600".

enroll_ttls

This is the list of times, given in seconds, before a certificate's not-after validity date (often referred to as its expiration time) when certmonger should attempt to automatically renew the certificate, if it is configured to do so. If this value is not specified, certmonger will attempt to use the value of the ttls setting. The default list of values is "2419200, 604800, 259200, 172800, 86400, 43200, 21600, 7200, 3600".

notification_method

This is the method by which certmonger will notify the system administrator that a certificate will soon become invalid. The recognized values are syslog, mail, and command. The default is syslog. When sending mail, the notification message will be the mail message subject. When invoking a command, the notification message and type will be available in the "CERTMONGER_NOTIFICATION" and "CERTMONGER_NOTIFICATION_TYPE" environment variables and the related request's nickname/ID will be available in the "CERTMONGER_NOTIFICATION_CERT_NICKNAME" environment variable.

notification_destination

This is the destination to which certmonger will send notifications. It can be a syslog priority and/or facility, separated by a period, it can be an email address, or it can be a command to run. The default value is daemon.notice.

key_type

This is the type of key pair which will be generated, used in certificate signing requests, and used when self-signing certificates. RSA is supported. EC (also known as ECDSA) is also supported. The default is RSA.

rsa_key_size

This is the size of an RSA key if the value is not included in a certificate request. If this value is not set then the default is 2048. The minimum value allowed is 1024.

symmetric_cipher

This is the symmetric cipher which will be used to encrypt private keys stored in OpenSSL's PEM format. Recognized values include aes128 and aes256. The default is aes128. It is not recommended that this value be changed except in cases where the default is incompatible with other software.

digest

This is the digest algorithm which will be used when signing certificate signing requests and self-signed certificates. Recognized values include sha1, sha256, sha384, and sha512. The default is sha256. It is not recommended that this value be changed except in cases where the default is incompatible with other software.

nss_ca_trust

These are the trust attributes which are applied to CA certificates which should be trusted, when they are saved to NSS databases. The default is CT,C,C.

nss_other_trust

These are the trust attributes which are applied to certificates which are not necessarily to be trusted, when they are saved to NSS databases. The default is ,,.

max_key_use_count

When attempting to replace a certificate, if certmonger has previously obtained at least this number of certificates using the current key pair, it will generate a new key pair to use before proceeding. There is effectively no default for this setting.

max_key_lifetime

The amount of time after a key was first generated when certmonger will attempt to generate a new key pair to replace it, as part of the process of replacing a certificate. The value is specified as a combination of years (y), months (M), weeks (w), days (d), hours (h), minutes (m), and/or seconds (s). If no unit of time is specified, seconds are assumed. The date when a key was generated is not recorded if the key was not generated by certmonger, or if the key was generated with a version of certmonger older than 0.78, and for those cases, this option has no effect. There is effectively no default for this setting.

## SELFSIGN
Within the selfsign section, these variables and values are recognized:

validity_period

This is the validity period given to self-signed certificates. The value is specified as a combination of years (y), months (M), weeks (w), days (d), hours (h), minutes (m), and/or seconds (s). If no unit of time is specified, seconds are assumed. The default value is 1y.

populate_unique_id

This controls whether or not self-signed certificates will have their subjectUniqueID and issuerUniqueID fields populated. While RFC5280 prohibits their use, they may be needed and/or used by older applications. The default value is no.

## LOCAL
Within the local section, these variables and values are recognized:

validity_period

This is the validity period given to the locally-signed CA's certificate when it is generated. The value is specified as a combination of years (y), months (M), weeks (w), days (d), hours (h), minutes (m), and/or seconds (s). If no unit of time is specified, seconds are assumed. If not set, the value of the validity_period setting from the selfsign section, if one is set there, will be used. The default value is 1y.

## SCEP
Within the scep section, these variables and values are recognized:

challenge_password_otp

This controls whether the SCEP challenge password is treated as a one-time password. If set to yes then the challenge password and/or challenge password file will be removed from the tracking request after the first certificate issuance so will not be sent with renewal requests. The default is no.

## BUGS
Please file tickets for any that you find at https://fedorahosted.org/certmonger/

## SEE ALSO
certmonger(8) certmonger_selinux(8)


cgitrc

package: cgit

title: cgitrc(5)

summary: runtime configuration for cgit

text:
# cgitrc(5)

## NAME
cgitrc - runtime configuration for cgit

## SYNOPSIS
Cgitrc contains all runtime settings for cgit, including the list of git repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank lines, and lines starting with #, are ignored.

## LOCATION
The default location of cgitrc, defined at compile time, is /etc/cgitrc. At runtime, cgit will consult the environment variable CGIT_CONFIG and, if defined, use its value instead.

## GLOBAL SETTINGS
about-filter

Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository). The command will get the content of the about-file on its STDIN, the name of the file as the first argument, and the STDOUT from the command will be included verbatim on the about page. Default value: none. See also: "FILTER API".

agefile

Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository. The first line in the file is used as input to the "parse_date" function in libgit. Recommended timestamp-format is "yyyy-mm-dd hh:mm:ss". You may want to generate this file from a post-receive hook. Default value: "info/web/last-modified".

auth-filter

Specifies a command that will be invoked for authenticating repository access. Receives quite a few arguments, and data on both stdin and stdout for authentication processing. Details follow later in this document. If no auth-filter is specified, no authentication is performed. Default value: none. See also: "FILTER API".

branch-sort

Flag which, when set to "age", enables date ordering in the branch ref list, and when set to "name" enables ordering by branch name. Default value: "name".

cache-about-ttl

Number which specifies the time-to-live, in minutes, for the cached version of the repository about page. See also: "CACHE". Default value: "15".

cache-dynamic-ttl

Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1. See also: "CACHE". Default value: "5".

cache-repo-ttl

Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page. See also: "CACHE". Default value: "5".

cache-root

Path used to store the cgit cache entries. Default value: "/var/cache/cgit". See also: "MACRO EXPANSION".

cache-root-ttl

Number which specifies the time-to-live, in minutes, for the cached version of the repository index page. See also: "CACHE". Default value: "5".

cache-scanrc-ttl

Number which specifies the time-to-live, in minutes, for the result of scanning a path for git repositories. See also: "CACHE". Default value: "15".

case-sensitive-sort

Sort items in the repo list case sensitively. Default value: "1". See also: repository-sort, section-sort.

cache-size

The maximum number of entries in the cgit cache. When set to "0", caching is disabled. See also: "CACHE". Default value: "0"

cache-snapshot-ttl

Number which specifies the time-to-live, in minutes, for the cached version of snapshots. See also: "CACHE". Default value: "5".

cache-static-ttl

Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1. See also: "CACHE". Default value: -1".

clone-prefix

Space-separated list of common prefixes which, when combined with a repository url, generates valid clone urls for the repository. This setting is only used if repo.clone-url is unspecified. Default value: none.

clone-url

Space-separated list of clone-url templates. This setting is only used if repo.clone-url is unspecified. Default value: none. See also: "MACRO EXPANSION", "FILTER API".

commit-filter

Specifies a command which will be invoked to format commit messages. The command will get the message on its STDIN, and the STDOUT from the command will be included verbatim as the commit message, i.e. this can be used to implement bugtracker integration. Default value: none. See also: "FILTER API".

commit-sort

Flag which, when set to "date", enables strict date ordering in the commit log, and when set to "topo" enables strict topological ordering. If unset, the default ordering of "git log" is used. Default value: unset.

css

Url which specifies the css document to include in all cgit pages. Default value: "/cgit.css". May be given multiple times, each css URL path is added in the head section of the document in turn.

email-filter

Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface. This command will receive an email address and an origin page string as its command line arguments, and the text to format on STDIN. It is to write the formatted text back out onto STDOUT. Default value: none. See also: "FILTER API".

embedded

Flag which, when set to "1", will make cgit generate a html fragment suitable for embedding in other html pages. Default value: none. See also: "noheader".

enable-blame

Flag which, when set to "1", will allow cgit to provide a "blame" page for files, and will make it generate links to that page in appropriate places. Default value: "0".

enable-commit-graph

Flag which, when set to "1", will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page. Default value: "0".

enable-filter-overrides

Flag which, when set to "1", allows all filter settings to be overridden in repository-specific cgitrc files. Default value: none.

enable-follow-links

Flag which, when set to "1", allows users to follow a file in the log view. Default value: "0".

enable-git-config

Flag which, when set to "1", will allow cgit to use git config to set any repo specific settings. This option is used in conjunction with "scan-path", and must be defined prior, to augment repo-specific settings. The keys gitweb.owner, gitweb.category, gitweb.description, and gitweb.homepage will map to the cgit keys repo.owner, repo.section, repo.desc, and repo.homepage respectively. All git config keys that begin with "cgit." will be mapped to the corresponding "repo." key in cgit. Default value: "0". See also: scan-path, section-from-path.

enable-http-clone

If set to "1", cgit will act as a dumb HTTP endpoint for git clones. You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url to expose this feature. If you use an alternate way of serving git repositories, you may wish to disable this. Default value: "1".

enable-html-serving

Flag which, when set to "1", will allow the /plain handler to serve mimetype headers that result in the file being treated as HTML by the browser. When set to "0", such file types are returned instead as text/plain or application/octet-stream. Default value: "0". See also: "repo.enable-html-serving".

enable-index-links

Flag which, when set to "1", will make cgit generate extra links for each repo in the repository index (specifically, to the "summary", "commit" and "tree" pages). Default value: "0".

enable-index-owner

Flag which, when set to "1", will make cgit display the owner of each repo in the repository index. Default value: "1".

enable-log-filecount

Flag which, when set to "1", will make cgit print the number of modified files for each commit on the repository log page. Default value: "0".

enable-log-linecount

Flag which, when set to "1", will make cgit print the number of added and removed lines for each commit on the repository log page. Default value: "0".

enable-remote-branches

Flag which, when set to "1", will make cgit display remote branches in the summary and refs views. Default value: "0". See also: "repo.enable-remote-branches".

enable-subject-links

Flag which, when set to "1", will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view. Default value: "0". See also: "repo.enable-subject-links".

enable-tree-linenumbers

Flag which, when set to "1", will make cgit generate linenumber links for plaintext blobs printed in the tree view. Default value: "1".

favicon

Url used as link to a shortcut icon for cgit. It is suggested to use the value "/favicon.ico" since certain browsers will ignore other values. Default value: "/favicon.ico".

footer

The content of the file specified with this option will be included verbatim at the bottom of all pages (i.e. it replaces the standard "generated by..." message. Default value: none.

head-include

The content of the file specified with this option will be included verbatim in the html HEAD section on all pages. Default value: none.

header

The content of the file specified with this option will be included verbatim at the top of all pages. Default value: none.

include

Name of a configfile to include before the rest of the current config- file is parsed. Default value: none. See also: "MACRO EXPANSION".

js

Url which specifies the javascript script document to include in all cgit pages. Default value: "/cgit.js". Setting this to an empty string will disable generation of the link to this file in the head section.

local-time

Flag which, if set to "1", makes cgit print commit and tag times in the servers timezone. Default value: "0".

logo

Url which specifies the source of an image which will be used as a logo on all cgit pages. Default value: "/cgit.png".

logo-link

Url loaded when clicking on the cgit logo image. If unspecified the calculated url of the repository index page will be used. Default value: none.

max-atom-items

Specifies the number of items to display in atom feeds view. Default value: "10".

max-blob-size

Specifies the maximum size of a blob to display HTML for in KBytes. Default value: "0" (limit disabled).

max-commit-count

Specifies the number of entries to list per page in "log" view. Default value: "50".

max-message-length

Specifies the maximum number of commit message characters to display in "log" view. Default value: "80".

max-repo-count

Specifies the number of entries to list per page on the repository index page. The value "0" shows all repositories without limitation. Default value: "50".

max-repodesc-length

Specifies the maximum number of repo description characters to display on the repository index page. Default value: "80".

max-stats

Set the default maximum statistics period. Valid values are "week", "month", "quarter" and "year". If unspecified, statistics are disabled. Default value: none. See also: "repo.max-stats".

mimetype.<ext>

Set the mimetype for the specified filename extension. This is used by the plain command when returning blob content.

mimetype-file

Specifies the file to use for automatic mimetype lookup. If specified then this field is used as a fallback when no "mimetype.<ext>" match is found. If unspecified then no such lookup is performed. The typical file to use on a Linux system is /etc/mime.types. The format of the file must comply to:

•a comment line is an empty line or a line starting with a hash (#), optionally preceded by whitespace

•a non-comment line starts with the mimetype (like image/png), followed by one or more file extensions (like jpg), all separated by whitespace Default value: none. See also: "mimetype.<ext>".

module-link

Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing. The arguments for the formatstring are the path and SHA1 of the submodule commit. Default value: none.

noplainemail

If set to "1" showing full author email addresses will be disabled. Default value: "0".

noheader

Flag which, when set to "1", will make cgit omit the standard header on all pages. Default value: none. See also: "embedded".

owner-filter

Specifies a command which will be invoked to format the Owner column of the main page. The command will get the owner on STDIN, and the STDOUT from the command will be included verbatim in the table. This can be used to link to additional context such as an owners home page. When active this filter is used instead of the default owner query url. Default value: none. See also: "FILTER API".

project-list

A list of subdirectories inside of scan-path, relative to it, that should loaded as git repositories. This must be defined prior to scan-path. Default value: none. See also: scan-path, "MACRO EXPANSION".

readme

Text which will be used as default value for "repo.readme". Multiple config keys may be specified, and cgit will use the first found file in this list. This is useful in conjunction with scan-path. Default value: none. See also: scan-path, repo.readme.

remove-suffix

If set to "1" and scan-path is enabled, if any repositories are found with a suffix of ".git", this suffix will be removed for the url and name. This must be defined prior to scan-path. Default value: "0". See also: scan-path.

renamelimit

Maximum number of files to consider when detecting renames. The value "-1" uses the compiletime value in git (for further info, look at man git-diff). Default value: "-1".

repository-sort

The way in which repositories in each section are sorted. Valid values are "name" for sorting by the repo name or "age" for sorting by the most recently updated repository. Default value: "name". See also: section, case-sensitive-sort, section-sort.

robots

Text used as content for the "robots" meta-tag. Default value: "index, nofollow".

root-desc

Text printed below the heading on the repository index page. Default value: "a fast webinterface for the git dscm".

root-readme

The content of the file specified with this option will be included verbatim below the "about" link on the repository index page. Default value: none.

root-title

Text printed as heading on the repository index page. Default value: "Git Repository Browser".

scan-hidden-path

If set to "1" and scan-path is enabled, scan-path will recurse into directories whose name starts with a period (.). Otherwise, scan-path will stay away from such directories (considered as "hidden"). Note that this does not apply to the ".git" directory in non-bare repos. This must be defined prior to scan-path. Default value: 0. See also: scan-path.

scan-path

A path which will be scanned for repositories. If caching is enabled, the result will be cached as a cgitrc include-file in the cache directory. If project-list has been defined prior to scan-path, scan-path loads only the directories listed in the file pointed to by project-list. Be advised that only the global settings taken before the scan-path directive will be applied to each repository. Default value: none. See also: cache-scanrc-ttl, project-list, "MACRO EXPANSION".

section

The name of the current repository section - all repositories defined after this option will inherit the current section name. Default value: none.

section-sort

Flag which, when set to "1", will sort the sections on the repository listing by name. Set this flag to "0" if the order in the cgitrc file should be preserved. Default value: "1". See also: section, case-sensitive-sort, repository-sort.

section-from-path

A number which, if defined prior to scan-path, specifies how many path elements from each repo path to use as a default section name. If negative, cgit will discard the specified number of path elements above the repo directory. Default value: "0".

side-by-side-diffs

If set to "1" shows side-by-side diffs instead of unidiffs per default. Default value: "0".

snapshots

Text which specifies the default set of snapshot formats that cgit generates links for. The value is a space-separated list of zero or more of the values "tar", "tar.gz", "tar.bz2", "tar.lz", "tar.xz", "tar.zst" and "zip". The special value "all" enables all snapshot formats. Default value: none. All compressors use default settings. Some settings can be influenced with environment variables, for example set ZSTD_CLEVEL=10 in web server environment for higher (but slower) zstd compression.

source-filter

Specifies a command which will be invoked to format plaintext blobs in the tree view. The command will get the blob content on its STDIN and the name of the blob as its only command line argument. The STDOUT from the command will be included verbatim as the blob contents, i.e. this can be used to implement e.g. syntax highlighting. Default value: none. See also: "FILTER API".

summary-branches

Specifies the number of branches to display in the repository "summary" view. Default value: "10".

summary-log

Specifies the number of log entries to display in the repository "summary" view. Default value: "10".

summary-tags

Specifies the number of tags to display in the repository "summary" view. Default value: "10".

strict-export

Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository. This can be used to emulate gitweb’s EXPORT_OK and STRICT_EXPORT functionality and limit cgit’s repositories to match those exported by git-daemon. This option must be defined prior to scan-path.

virtual-root

Url which, if specified, will be used as root for all cgit links. It will also cause cgit to generate virtual urls, i.e. urls like /cgit/tree/README as opposed to ?r=cgit&p=tree&path=README. Default value: none. NOTE: cgit has recently learned how to use PATH_INFO to achieve the same kind of virtual urls, so this option will probably be deprecated.

## REPOSITORY SETTINGS
repo.about-filter

Override the default about-filter. Default value: none. See also: "enable-filter-overrides". See also: "FILTER API".

repo.branch-sort

Flag which, when set to "age", enables date ordering in the branch ref list, and when set to "name" enables ordering by branch name. Default value: "name".

repo.clone-url

A list of space-separated urls which can be used to clone this repo. Default value: none. See also: "MACRO EXPANSION".

repo.commit-filter

Override the default commit-filter. Default value: none. See also: "enable-filter-overrides". See also: "FILTER API".

repo.commit-sort

Flag which, when set to "date", enables strict date ordering in the commit log, and when set to "topo" enables strict topological ordering. If unset, the default ordering of "git log" is used. Default value: unset.

repo.defbranch

The name of the default branch for this repository. If no such branch exists in the repository, the first branch name (when sorted) is used as default instead. Default value: branch pointed to by HEAD, or "master" if there is no suitable HEAD.

repo.desc

The value to show as repository description. Default value: none.

repo.email-filter

Override the default email-filter. Default value: none. See also: "enable-filter-overrides". See also: "FILTER API".

repo.enable-blame

A flag which can be used to disable the global setting ‘enable-blame’. Default value: none.

repo.enable-commit-graph

A flag which can be used to disable the global setting ‘enable-commit-graph’. Default value: none.

repo.enable-follow-links

A flag which can be used to disable the global setting ‘enable-follow-links’. Default value: none.

repo.enable-html-serving

A flag which can be used to override the global setting enable-html-serving. Default value: none.

repo.enable-log-filecount

A flag which can be used to disable the global setting ‘enable-log-filecount’. Default value: none.

repo.enable-log-linecount

A flag which can be used to disable the global setting ‘enable-log-linecount’. Default value: none.

repo.enable-remote-branches

Flag which, when set to "1", will make cgit display remote branches in the summary and refs views. Default value: <enable-remote-branches>.

repo.enable-subject-links

A flag which can be used to override the global setting ‘enable-subject-links’. Default value: none.

repo.extra-head-content

This value will be added verbatim to the head section of each page displayed for this repo. Default value: none.

repo.hide

Flag which, when set to "1", hides the repository from the repository index. The repository can still be accessed by providing a direct path. Default value: "0". See also: "repo.ignore".

repo.homepage

The value to show as repository homepage. Default value: none.

repo.ignore

Flag which, when set to "1", ignores the repository. The repository is not shown in the index and cannot be accessed by providing a direct path. Default value: "0". See also: "repo.hide".

repo.logo

Url which specifies the source of an image which will be used as a logo on this repo’s pages. Default value: global logo.

repo.logo-link

Url loaded when clicking on the cgit logo image. If unspecified the calculated url of the repository index page will be used. Default value: global logo-link.

repo.module-link

Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing. The arguments for the formatstring are the path and SHA1 of the submodule commit. Default value: <module-link>

repo.module-link.<path>

Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory listing. The only argument for the formatstring is the SHA1 of the submodule commit. Default value: none.

repo.max-stats

Override the default maximum statistics period. Valid values are equal to the values specified for the global "max-stats" setting. Default value: none.

repo.name

The value to show as repository name. Default value: <repo.url>.

repo.owner

A value used to identify the owner of the repository. Default value: none.

repo.owner-filter

Override the default owner-filter. Default value: none. See also: "enable-filter-overrides". See also: "FILTER API".

repo.path

An absolute path to the repository directory. For non-bare repositories this is the .git-directory. Default value: none.

repo.readme

A path (relative to <repo.path>) which specifies a file to include verbatim as the "About" page for this repo. You may also specify a git refspec by head or by hash by prepending the refspec followed by a colon. For example, "master:docs/readme.mkd". If the value begins with a colon, i.e. ":docs/readme.rst", the head giving in query or the default branch of the repository will be used. Sharing any file will expose that entire directory tree to the "/about/PATH" endpoints, so be sure that there are no non-public files located in the same directory as the readme file. Default value: <readme>.

repo.section

Override the current section name for this repository. Default value: none.

repo.snapshots

A mask of snapshot formats for this repo that cgit generates links for, restricted by the global "snapshots" setting. Default value: <snapshots>.

repo.snapshot-prefix

Prefix to use for snapshot links instead of the repository basename. For example, the "linux-stable" repository may wish to set this to "linux" so that snapshots are in the format "linux-3.15.4" instead of "linux-stable-3.15.4". Default value: <empty> meaning to use the repository basename.

repo.source-filter

Override the default source-filter. Default value: none. See also: "enable-filter-overrides". See also: "FILTER API".

repo.url

The relative url used to access the repository. This must be the first setting specified for each repo. Default value: none.

## REPOSITORY-SPECIFIC CGITRC FILE
When the option "scan-path" is used to auto-discover git repositories, cgit will try to parse the file "cgitrc" within any found repository. Such a repo-specific config file may contain any of the repo-specific options described above, except "repo.url" and "repo.path". Additionally, the "filter" options are only acknowledged in repo-specific config files when "enable-filter-overrides" is set to "1".

Note: the "repo." prefix is dropped from the option names in repo-specific config files, e.g. "repo.desc" becomes "desc".

## FILTER API
By default, filters are separate processes that are executed each time they are needed. Alternative technologies may be used by prefixing the filter specification with the relevant string; available values are:

exec:

The default "one process per filter" mode.

lua:

Executes the script using a built-in Lua interpreter. The script is loaded once per execution of cgit, and may be called multiple times during cgit’s lifetime, making it a good choice for repeated filters such as the email filter. It responds to three functions:

filter_open(argument1, argument2, argument3, ...)

This is called upon activation of the filter for a particular set of data.

filter_write(buffer)

This is called whenever cgit writes data to the webpage.

filter_close()

This is called when the current filtering operation is completed. It must return an integer value. Usually 0 indicates success.

```
Additionally, cgit exposes to the Lua the following built-in functions:
```

html(str)

Writes str to the webpage.

html_txt(str)

HTML escapes and writes str to the webpage.

html_attr(str)

HTML escapes for an attribute and writes "str' to the webpage.

html_url_path(str)

URL escapes for a path and writes str to the webpage.

html_url_arg(str)

URL escapes for an argument and writes str to the webpage.

html_include(file)

Includes file in webpage.

Parameters are provided to filters as follows.

about filter

This filter is given a single parameter: the filename of the source file to filter. The filter can use the filename to determine (for example) the type of syntax to follow when formatting the readme file. The about text that is to be filtered is available on standard input and the filtered text is expected on standard output.

auth filter

The authentication filter receives 12 parameters:

•filter action, explained below, which specifies which action the filter is called for

•http cookie

•http method

•http referer

•http path

•http https flag

•cgit repo

•cgit page

•cgit url

•cgit login url When the filter action is "body", this filter must write to output the HTML for displaying the login form, which POSTs to the login url. When the filter action is "authenticate-cookie", this filter must validate the http cookie and return a 0 if it is invalid or 1 if it is invalid, in the exit code / close function. If the filter action is "authenticate-post", this filter receives POST’d parameters on standard input, and should write a complete CGI response, preferably with a 302 redirect, and write to output one or more "Set-Cookie" HTTP headers, each followed by a newline.

```
Please see `filters/simple-authentication.lua` for a clear example
script that may be modified.
```

commit filter

This filter is given no arguments. The commit message text that is to be filtered is available on standard input and the filtered text is expected on standard output.

email filter

This filter is given two parameters: the email address of the relevant author and a string indicating the originating page. The filter will then receive the text string to format on standard input and is expected to write to standard output the formatted text to be included in the page.

owner filter

This filter is given no arguments. The owner text is available on standard input and the filter is expected to write to standard output. The output is included in the Owner column.

source filter

This filter is given a single parameter: the filename of the source file to filter. The filter can use the filename to determine (for example) the syntax highlighting mode. The contents of the source file that is to be filtered is available on standard input and the filtered contents is expected on standard output.

All filters are handed the following environment variables:

•CGIT_REPO_URL (from repo.url)

•CGIT_REPO_NAME (from repo.name)

•CGIT_REPO_PATH (from repo.path)

•CGIT_REPO_OWNER (from repo.owner)

•CGIT_REPO_DEFBRANCH (from repo.defbranch)

•CGIT_REPO_SECTION (from repo.section)

•CGIT_REPO_CLONE_URL (from repo.clone-url)

If a setting is not defined for a repository and the corresponding global setting is also not defined (if applicable), then the corresponding environment variable will be unset.

## MACRO EXPANSION
The following cgitrc options support a simple macro expansion feature, where tokens prefixed with "$" are replaced with the value of a similarly named environment variable:

•cache-root

•include

•project-list

•scan-path

Macro expansion will also happen on the content of $CGIT_CONFIG, if defined.

One usage of this feature is virtual hosting, which in its simplest form can be accomplished by adding the following line to /etc/cgitrc:

```
include=/etc/cgitrc.d/$HTTP_HOST
```

The following options are expanded during request processing, and support the environment variables defined in "FILTER API":

•clone-url

•repo.clone-url

## CACHE
All cache ttl values are in minutes. Negative ttl values indicate that a page type will never expire, and thus the first time a URL is accessed, the result will be cached indefinitely, even if the underlying git repository changes. Conversely, when a ttl value is zero, the cache is disabled for that particular page type, and the page type is never cached.

## SIGNATURES
Cgit can host .asc signatures corresponding to various snapshot formats, through use of git notes. For example, the following command may be used to add a signature to a .tar.xz archive:

```
git notes --ref=refs/notes/signatures/tar.xz add -C "$(

    gpg --output - --armor --detach-sign cgit-1.1.tar.xz |

    git hash-object -w --stdin
)" v1.1
```

If it is instead desirable to attach a signature of the underlying .tar, this will be linked, as a special case, beside a .tar.* link that does not have its own signature. For example, a signature of a tarball of the latest tag might be added with a similar command:

```
tag="$(git describe --abbrev=0)"
git notes --ref=refs/notes/signatures/tar add -C "$(

    git archive --format tar --prefix "cgit-${tag#v}/" "$tag" |

    gpg --output - --armor --detach-sign |

    git hash-object -w --stdin
)" "$tag"
```

Since git-archive(1) is expected to produce stable output between versions, this allows one to generate a long-term signature of the contents of a given tag.

## EXAMPLE CGITRC FILE

```
# Enable caching of up to 1000 output entries
cache-size=1000
# Specify some default clone urls using macro expansion
clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
# Specify the css url
css=/css/cgit.css
# Show owner on index page
enable-index-owner=1
# Allow http transport git clone
enable-http-clone=1
# Show extra links for each repository on the index page
enable-index-links=1
# Enable blame page and create links to it from tree page
enable-blame=1
# Enable ASCII art commit history graph on the log pages
enable-commit-graph=1
# Show number of affected files per commit on the log pages
enable-log-filecount=1
# Show number of added/removed lines per commit on the log pages
enable-log-linecount=1
# Sort branches by date
branch-sort=age
# Add a cgit favicon
favicon=/favicon.ico
# Use a custom logo
logo=/img/mylogo.png
# Enable statistics per week, month and quarter
max-stats=quarter
# Set the title and heading of the repository index page
root-title=example.com git repositories
# Set a subheading for the repository index page
root-desc=tracking the foobar development
# Include some more info about example.com on the index page
root-readme=/var/www/htdocs/about.html
# Allow download of tar.gz, tar.bz2 and zip-files
snapshots=tar.gz tar.bz2 zip
##
## List of common mimetypes
##
mimetype.gif=image/gif
mimetype.html=text/html
mimetype.jpg=image/jpeg
mimetype.jpeg=image/jpeg
mimetype.pdf=application/pdf
mimetype.png=image/png
mimetype.svg=image/svg+xml
# Highlight source code with python pygments-based highlighter
source-filter=/var/www/cgit/filters/syntax-highlighting.py
# Format markdown, restructuredtext, manpages, text files, and html files
# through the right converters
about-filter=/var/www/cgit/filters/about-formatting.sh
##
## Search for these files in the root of the default branch of repositories
## for coming up with the about page:
##
readme=:README.md
readme=:readme.md
readme=:README.mkd
readme=:readme.mkd
readme=:README.rst
readme=:readme.rst
readme=:README.html
readme=:readme.html
readme=:README.htm
readme=:readme.htm
readme=:README.txt
readme=:readme.txt
readme=:README
readme=:readme
readme=:INSTALL.md
readme=:install.md
readme=:INSTALL.mkd
readme=:install.mkd
readme=:INSTALL.rst
readme=:install.rst
readme=:INSTALL.html
readme=:install.html
readme=:INSTALL.htm
readme=:install.htm
readme=:INSTALL.txt
readme=:install.txt
readme=:INSTALL
readme=:install
##
## List of repositories.
## PS: Any repositories listed when section is unset will not be
##     displayed under a section heading
## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
##      and included like this:
##        include=/etc/cgitrepos
##
repo.url=foo
repo.path=/pub/git/foo.git
repo.desc=the master foo repository
repo.owner=fooman@example.com
repo.readme=info/web/about.html
repo.url=bar
repo.path=/pub/git/bar.git
repo.desc=the bars for your foo
repo.owner=barman@example.com
repo.readme=info/web/about.html
# The next repositories will be displayed under the 'extras' heading
section=extras
repo.url=baz
repo.path=/pub/git/baz.git
repo.desc=a set of extensions for bar users
repo.url=wiz
repo.path=/pub/git/wiz.git
repo.desc=the wizard of foo
# Add some mirrored repositories
section=mirrors
repo.url=git
repo.path=/pub/git/git.git
repo.desc=the dscm
repo.url=linux
repo.path=/pub/git/linux.git
repo.desc=the kernel
# Disable adhoc downloads of this repo
repo.snapshots=0
# Disable line-counts for this repo
repo.enable-log-linecount=0
# Restrict the max statistics period for this repo
repo.max-stats=month
```

## BUGS
Comments currently cannot appear on the same line as a setting; the comment will be included as part of the value. E.g. this line:

```
robots=index  # allow indexing
```

will generate the following html element:

```
<meta name='robots' content='index  # allow indexing'/>
```

## AUTHOR
Lars Hjemli <hjemli@gmail.com> Jason A. Donenfeld <Jason@zx2c4.com>


cgreen

package: cgreen

title: cgreen(5)

text:
# cgreen(5)

## NAME
cgreen - a framework for C and C++ unit tests and mocking

## DESCRIPTION
Cgreen is a framework for creating and running compact and easy-to-read unittests for C and/or C++.

Here are some of its features:

•

Fluent API resulting in very readable tests

•

Expressive and clear output using the default reporter

•

Fully functional mocks, both strict and loose

•

Each test runs in its own process for test suite robustness

•

Automatic discovery and running of tests using dynamic library inspection

•

Extensive and expressive constraints for many datatypes

•

BDD-flavoured test declarations with Before and After declarations

•

Extensible reporting mechanism

•

Fully composable test suites

•

An isolated test can be run in a single process for debugging

## SEE ALSO
cgreen-runner(1)

The full documentation for cgreen-runner and the Cgreen framework is in the Cgreen manual available at


cgconfig.conf

package: cgroup

title: cgconfig.conf(5)

summary: libcgroup configuration file

text:
# cgconfig.conf(5)

## NAME
cgconfig.conf - libcgroup configuration file

## DESCRIPTION
cgconfig.conf is a configuration file used by libcgroup to define control groups, their parameters and their mount points. The file consists of mount , group and default sections. These sections can be in arbitrary order and all of them are optional. Any line starting with '#' is considered a comment line and is ignored.

mount section has this form:

```
mount {
```

```
<controller> = <path>;
...
```

```
}
```

controller

Name of the kernel subsystem. The list of subsystems supported by the kernel can be found in /proc/cgroups file. Named hierarchy can be specified as controller "name=<somename>". Do not forget to use double quotes around this controller name (see examples below). Apart from named hierarchy, additional mount options may be specified by putting the controller and the options in quotes. Options supported are nosuid, noexec and nodev. Libcgroup merges all subsystems mounted to the same directory (see Example 1) and the directory is mounted only once.

path

The directory path where the group hierarchy associated to a given controller shall be mounted. The directory is created automatically on cgconfig service startup if it does not exist and is deleted on service shutdown.

If no mount section is specified, no controllers are mounted.

group section has this form:

```
group <name> {
```

```
[permissions]
<controller> {
```

```
<param name> = <param value>;
...
```

```
}
...
```

```
}
```

name

Name of the control group. It can contain only characters, which are allowed for directory names. The groups form a tree, i.e. a control group can contain zero or more subgroups. Subgroups can be specified using '/' delimiter. The root control group is always created automatically in all hierarchies and it is the base of the group hierarchy. It can be explicitly specified in cgconfig.conf by using '.' as group name. This can be used e.g. to set its permissions, as shown in Example 6.

When the parent control group of a subgroup is not specified it is created automatically.

permissions

Permissions of the given control group on mounted filesystem. root has always permission to do anything with the control group. Permissions have the following syntax:

```
perm {
```

```
task {
```

```
uid = <task user>;
gid = <task group>;
fperm = <file permissions>
```

```
}
admin {
```

```
uid = <admin name>;
gid = <admin group>;
dperm = <directory permissions>
fperm = <file permissions>
```

```
}
```

```
}
```

task user/group

Name of the user and the group, which own the tasks file of the control group. Given fperm then specify the file permissions. Please note that the given value is not used as was specified. Instead, current file owner permissions are used as a "umask" for group and others permissions. For example if fperm = 777 then both group and others will get the same permissions as the file owner.

admin user/group

Name of the user and the group which own the rest of control group's files. Given fperm and dperm control file and directory permissions. Again, the given value is masked by the file/directory owner permissions.

Permissions are only apply to the enclosing control group and are not inherited by subgroups. If there is no perm section in the control group definition, root:root is the owner of all files and default file permissions are preserved if fperm resp. dperm are not specified.

controller

Name of the kernel subsystem. The section can be empty, default kernel parameters will be used in this case. By specifying controller the control group and all its parents are controlled by the specific subsystem. One control group can be controlled by multiple subsystems, even if the subsystems are mounted on different directories. Each control group must be controlled by at least one subsystem, so that libcgroup knows in which hierarchies the control group should be created. The parameters of the given controller can be modified in the following section enclosed in brackets.

param name

Name of the file to set. Each controller can have zero or more parameters.

param value

Value which should be written to the file when the control group is created. If it is enclosed in double quotes `"', it can contain spaces and other special characters.

If no group section is specified, no groups are created.

default section has this form:

```
default {
```

```
perm {
```

```
task {
```

```
uid = <task user>;
gid = <task group>;
fperm = <file permissions>
```

```
}
admin {
```

```
uid = <admin name>;
gid = <admin group>;
dperm = <directory permissions>
fperm = <file permissions>
```

```
}
```

```
}
```

```
}
```

Content of the perm section has the same form as in group section. The permissions defined here specify owner and permissions of groups and files of all groups, which do not have explicitly specified their permissions in their group section.

template section has the same structure as group section. Template name uses the same templates string as cgrules.conf destination tag (see (cgrules.conf (5)). Template definition is used as a control group definition for rules in cgrules.conf (5) with the same destination name. Templates does not use default section settings.

systemd section has this form (supported on cgroup v2):

```
systemd {
```

```
slice = <slice-name.slice>;
scope = <scope-name.scope>;
setdefault = <yes>;
pid = <pid>;
```

```
}
```

slice

The name of the systemd slice unit, should end with '.slice' and obey the rules set forth by systemd slice unit. The slice unit is created, if it doesn't exist. This configuration requires 'scope=<scope-name.scope>'. The term 'unit' and 'cgroup' is used interchangeably.

scope

The name of the systemd scope unit should end with '.scope' and obey the rules set forth by systemd transient scope unit. This configuration requires 'slice=<slice-name.scope>'

setdefault

Set the scope as the default libcgroup scope. This default scope is used by libcgroup tools to build up the cgroup path.

pid

Moves the provided pid into the <slice-name.slice>/<scope-name.scope>. Without this configuration, libcgroup will create and attach a default idle program 'libcgroup_systemd_idle_thread' required by a systemd transient scope unit. The 'scope-name.scope' is automatically removed by systemd when the last task in the cgroup exits, but the 'slice-name.slice' will exist until manually removed.

/etc/cgconfig.d/ directory can be used for additional configuration files. cgrulesengd searches this directory for additional templates.

## EXAMPLES

### Example 1
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpu;
```

```
}
```

creates the hierarchy controlled by two subsystems with no groups inside. It corresponds to the following operations:

```
mkdir /mnt/cgroups/cpu
mount -t cgroup -o cpu,cpuacct cpu /mnt/cgroups/cpu
```

### Example 2
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
"name=scheduler" = /mnt/cgroups/cpu;
"name=noctrl" = /mnt/cgroups/noctrl;
```

```
}
group daemons {
```

```
cpu {
```

```
cpu.shares = "1000";
```

```
}
```

```
}
group test {
```

```
"name=noctrl" {
}
```

```
}
```

```

```

creates two hierarchies. One hierarchy named scheduler controlled by cpu subsystem, with group daemons inside. Second hierarchy is named noctrl without any controller, with group test. It corresponds to following operations:

```
mkdir /mnt/cgroups/cpu
mount -t cgroup -o cpu,name=scheduler cpu /mnt/cgroups/cpu
mount -t cgroup -o none,name=noctrl none /mnt/cgroups/noctrl
mkdir /mnt/cgroups/cpu/daemons
echo 1000 > /mnt/cgroups/cpu/daemons/www/cpu.shares
mkdir /mnt/cgroups/noctrl/tests
```

The daemons group is created automatically when its first subgroup is created. All its parameters have the default value and only root can access group's files.

Since both cpuacct and cpu subsystems are mounted to the same directory, all groups are implicitly controlled also by cpuacct subsystem, even if there is no cpuacct section in any of the groups.

### Example 3
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpu;
```

```
}
group daemons/www {
```

```
perm {
```

```
task {
```

```
uid = root;
gid = webmaster;
fperm = 770;
```

```
}
admin {
```

```
uid = root;
gid = root;
dperm = 775;
fperm = 744;
```

```
}
```

```
}
cpu {
```

```
cpu.shares = "1000";
```

```
}
```

```
}
group daemons/ftp {
```

```
perm {
```

```
task {
```

```
uid = root;
gid = ftpmaster;
fperm = 774;
```

```
}
admin {
```

```
uid = root;
gid = root;
dperm = 755;
fperm = 700;
```

```
}
```

```
}
cpu {
```

```
cpu.shares = "500";
```

```
}
```

```
}
```

```

```

creates the hierarchy controlled by two subsystems with one group and two subgroups inside, setting one parameter. It corresponds to the following operations (except for file permissions which are little bit trickier to emulate via chmod):

```
mkdir /mnt/cgroups/cpu
mount -t cgroup -o cpu,cpuacct cpu /mnt/cgroups/cpu
mkdir /mnt/cgroups/cpu/daemons
mkdir /mnt/cgroups/cpu/daemons/www
chown root:root /mnt/cgroups/cpu/daemons/www/*
chown root:webmaster /mnt/cgroups/cpu/daemons/www/tasks
echo 1000 > /mnt/cgroups/cpu/daemons/www/cpu.shares

 # + chmod the files so the result looks like:

 # ls -la /mnt/cgroups/cpu/daemons/www/

 # admin.dperm = 755:

 # drwxr-xr-x. 2 root webmaster 0 Jun 16 11:51 .

 #

 # admin.fperm = 744:

 # --w-------. 1 root webmaster 0 Jun 16 11:51 cgroup.event_control

 # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cgroup.procs

 # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.stat

 # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage

 # -r--r--r--. 1 root webmaster 0 Jun 16 11:51 cpuacct.usage_percpu

 # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.rt_period_us

 # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.rt_runtime_us

 # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 cpu.shares

 # -rw-r--r--. 1 root webmaster 0 Jun 16 11:51 notify_on_release

 #

 # tasks.fperm = 770

 # -rw-rw----. 1 root webmaster 0 Jun 16 11:51 tasks
mkdir /mnt/cgroups/cpu/daemons/ftp
chown root:root /mnt/cgroups/cpu/daemons/ftp/*
chown root:ftpmaster /mnt/cgroups/cpu/daemons/ftp/tasks
echo 500 > /mnt/cgroups/cpu/daemons/ftp/cpu.shares

 # + chmod the files so the result looks like:

 # ls -la /mnt/cgroups/cpu/daemons/ftp/

 # admin.dperm = 755:

 # drwxr-xr-x. 2 root ftpmaster 0 Jun 16 11:51 .

 #

 # admin.fperm = 700:

 # --w-------. 1 root ftpmaster 0 Jun 16 11:51 cgroup.event_control

 # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cgroup.procs

 # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.stat

 # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage

 # -r--------. 1 root ftpmaster 0 Jun 16 11:51 cpuacct.usage_percpu

 # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_period_us

 # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.rt_runtime_us

 # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 cpu.shares

 # -rw-------. 1 root ftpmaster 0 Jun 16 11:51 notify_on_release

 #

 # tasks.fperm = 774:

 # -rw-rw-r--. 1 root ftpmaster 0 Jun 16 11:51 tasks
```

The daemons group is created automatically when its first subgroup is created. All its parameters have the default value and only root can access the group's files.

Since both cpuacct and cpu subsystems are mounted to the same directory, all groups are implicitly also controlled by the cpuacct subsystem, even if there is no cpuacct section in any of the groups.

### Example 4
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpuacct;
```

```
}
group daemons {
```

```
cpuacct{
}
cpu {
}
```

```
}
```

creates two hierarchies and one common group in both of them. It corresponds to the following operations:

```
mkdir /mnt/cgroups/cpu
mkdir /mnt/cgroups/cpuacct
mount -t cgroup -o cpu cpu /mnt/cgroups/cpu
mount -t cgroup -o cpuacct cpuacct /mnt/cgroups/cpuacct
mkdir /mnt/cgroups/cpu/daemons
mkdir /mnt/cgroups/cpuacct/daemons
```

In fact there are two groups created. One in the cpuacct hierarchy, the second in the cpu hierarchy. These two groups have nothing in common and can contain different subgroups and different tasks.

### Example 5
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpuacct;
```

```
}
group daemons {
```

```
cpuacct{
}
```

```
}
group daemons/www {
```

```
cpu {
```

```
cpu.shares = "1000";
```

```
}
```

```
}
group daemons/ftp {
```

```
cpu {
```

```
cpu.shares = "500";
```

```
}
```

```
}
```

creates two hierarchies with few groups inside. One of the groups is created in both hierarchies. It corresponds to the following operations:

```
mkdir /mnt/cgroups/cpu
mkdir /mnt/cgroups/cpuacct
mount -t cgroup -o cpu cpu /mnt/cgroups/cpu
mount -t cgroup -o cpuacct cpuacct /mnt/cgroups/cpuacct
mkdir /mnt/cgroups/cpuacct/daemons
mkdir /mnt/cgroups/cpu/daemons
mkdir /mnt/cgroups/cpu/daemons/www
echo 1000 > /mnt/cgroups/cpu/daemons/www/cpu.shares
mkdir /mnt/cgroups/cpu/daemons/ftp
echo 500 > /mnt/cgroups/cpu/daemons/ftp/cpu.shares
```

Group daemons is created in both hierarchies. In the cpuacct hierarchy the group is explicitly mentioned in the configuration file. In the cpu hierarchy the group is created implicitly when www is created there. These two groups have nothing in common, for example they do not share processes and subgroups. Groups www and ftp are created only in the cpu hierarchy and are not controlled by the cpuacct subsystem.

### Example 6
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpu;
```

```
}
group . {
```

```
perm {
```

```
task {
```

```
uid = root;
gid = operator;
```

```
}
admin {
```

```
uid = root;
gid = operator;
```

```
}
```

```
}
cpu {
}
```

```
}
group daemons {
```

```
perm {
```

```
task {
```

```
uid = root;
gid = daemonmaster;
```

```
}
admin {
```

```
uid = root;
gid = operator;
```

```
}
```

```
}
cpu {
}
```

```
}
```

```

```

creates the hierarchy controlled by two subsystems with one group having some special permissions. It corresponds to the following operations:

```
mkdir /mnt/cgroups/cpu
mount -t cgroup -o cpu,cpuacct cpu /mnt/cgroups/cpu
chown root:operator /mnt/cgroups/cpu/*
chown root:operator /mnt/cgroups/cpu/tasks
mkdir /mnt/cgroups/cpu/daemons
chown root:operator /mnt/cgroups/cpu/daemons/*
chown root:daemonmaster /mnt/cgroups/cpu/daemons/tasks
```

Users which are members of the operator group are allowed to administer the control groups, i.e. create new control groups and move processes between these groups without having root privileges.

Members of the daemonmaster group can move processes to the daemons control group, but they can not move the process out of the group. Only the operator or root can do that.

### Example 7
The configuration file:

```
mount {
```

```
cpu = /mnt/cgroups/cpu;
cpuacct = /mnt/cgroups/cpuacct;
```

```
}
group students {
```

```
cpuacct{
}
cpu {
}
```

```
}
template students/%u {
```

```
cpuacct{
}
cpu {
}
```

```
}
mkdir /mnt/cgroups/cpu/daemons
mkdir /mnt/cgroups/cpuacct/daemons
```

The situation is the similar as in Example 4. The only difference is template, which is used if some rule uses "/students/%u" as a destination.

### Example 8
The configuration file:

```
mount {
```

```
"cpu,nodev,nosuid,noexec" = /mnt/cgroups/cpu;
```

```
}
```

This is the same as mount -t cgroup cgroup -o nodev,nosuid,noexec,cpu /mnt/cgroups/cpu It mounts the cpu controller with MS_NODEV, MS_NOSUID and MS_NOEXEC options passed.

### Example 9
The configuration file:

```
systemd {
```

```
slice = database.slice;
scope = db.scope;
setdefault = yes;
```

```
}
```

This creates a systemd transient scope unit db.scope under the systemd slice unit database.slice and spawns a libcgroup_systemd_idle_thread in the scope cgroup unit. The 'setdefault' configuration appends database.slice/db.scope to the path constructed by libcgroup and its tools.

## RECOMMENDATIONS

### Keep hierarchies separated
Having multiple hierarchies is perfectly valid and can be useful in various scenarios. To keeps things clean, do not create one group in multiple hierarchies. Examples 4 and 5 show how unreadable and confusing it can be, especially when reading somebody elses configuration file.

### Explicit is better than implicit
libcgroup can implicitly create groups which are needed for the creation of configured subgroups. This may be useful and save some typing in simple scenarios. When it comes to multiple hierarchies, it's better to explicitly specify all groups and all controllers related to them.

## FILES
/etc/cgconfig.conf

default libcgroup configuration file

/etc/cgconfig.d/

default libcgroup configuration files directory

## SEE ALSO
cgconfigparser (8)

## BUGS
Parameter values must be single strings without spaces. Parsing of quoted strings is not implemented.


cgred.conf

title: cgred.conf(5)

summary: libcgroup configuration file

text:
# cgred.conf(5)

## NAME
cgred.conf - libcgroup configuration file

## DESCRIPTION
cgred.conf is cgred service configuration file. In this file there could be defined several internal values. Defining anything else in this file will cause the CGroup Rules Daemon program to fail.

CONFIG_FILE

specifies the configuration file for cgred service

LOG_FILE

variable specifies the file to which logs will be written (by default they are not sent to a file but to syslog)

NODAEMON

if it is equal to "--nodaemon" then run cgred in non-daemon mode

LOG

define the verbosity of logging. Accepted values are '-v', '-vv', '-q' and '--nolog'.

## FILES
/etc/cgred.conf

default libcgroup configuration file

## SEE ALSO
cgrules.conf (5), cgconfig.conf (5), cgrules.d (5)


cgrules.conf

title: cgrules.conf(5)

summary: libcgroup configuration file

text:
# cgrules.conf(5)

## NAME
cgrules.conf - libcgroup configuration file

## DESCRIPTION
cgrules.conf configuration file is used by libcgroups to define control groups to which a process belongs.

The file contains a list of rules which assign to a defined group/user a control group in a subsystem (or control groups in subsystems).

Rules have two formats:

```
<user>               	<controllers>		<destination>
```

```
<user>:<process name>	<controllers>		<destination>
```

Where:

user can be:

```
    - a user name

    - a group name with @group syntax

    - the wildcard '*', for any user or group

    - '%', which is equivalent to "ditto" (useful for

      multi-line rules where different cgroups need to be

      specified for various hierarchies for a single user)
```

process name is optional and it can be:

```
    - a process name

    - a full command path of a process
```

controllers can be:

```
    - comma separated controller names (no spaces) or

    - * (for all mounted controllers)
```

destination can be:

```
    - path relative to the controller hierarchy (ex. pgrp1/gid1/uid1)

    - following strings called "templates" and will get expanded

          %u     username, uid if name resolving fails

          %U     uid

          %g     group name, gid if name resolving fails

          %G     gid

          %p     process name, pid if name not available

          %P     pid

          '\' can be used to escape '%'
```

First rule which matches the criteria will be executed. Any text starting with '#' is considered as a start of comment line and is ignored.

If the destination contains template string, the control group can be created on-fly. In time when some process wants to use the template rule which leads to control group (see cgexec (1)) and the control group does not exist, the group is created. The template control group parameters can be specified in cgconfig.conf configuration file. See (cgconfig.conf (5)). If the template definition is not found there created group have default kernel setting.

To create a hierarchy of configuration files, use /etc/cgrules.d directory.

## EXAMPLES

```
student         devices         /usergroup/students
```

Student's processes in the 'devices' subsystem belong to the control group /usergroup/students.

```
student:cp       devices         /usergroup/students/cp
```

When student executes 'cp' command, the processes in the 'devices' subsystem belong to the control group /usergroup/students/cp.

```
@admin           *              admingroup/
```

Processes started by anybody from admin group no matter in what subsystem belong to the control group admingroup/.

```
peter           cpu             test1/
%               memory          test2/
```

The first line says Peter's task for cpu controller belongs to test1 control group. The second one says Peter's tasks for memory controller belong to test2/ control group.

```
*               *               default/
```

All processes in any subsystem belong to the control group default/. Since the earliest matched rule is applied, it makes sense to have this line at the end of the list. It will put a task which was not mentioned in the previous rules to default/ control group.

```
@students	cpu,cpuacct	students/%u
```

Processes in cpu and cpuacct subsystems started by anybody from students group belong to group students/name. Where "name" is user name of owner of the process.

## FILES
/etc/cgrules.conf

default libcgroup configuration file

/etc/cgrules.d

default libcgroup configuration files directory

## SEE ALSO
cgconfig.conf (5), cgclassify (1), cgred.conf (5), cgrules.d (5)


default.cfg

package: chocolate-common

title: default.cfg(5)

summary: Chocolate Doom configuration file

text:
# default.cfg(5)

## NAME
default.cfg - Chocolate Doom configuration file

## DESCRIPTION
default.cfg is the configuration file for chocolate-doom(6). The configuration options stored in the file are the same as those stored in the original DOS Vanilla Doom. Extra Chocolate Doom-specific options are stored in a separate configuration file, chocolate-doom.cfg.

default.cfg is normally stored in the user's home directory, as ~/.local/share/chocolate-doom/default.cfg. The path can be overridden using the XDG_DATA_HOME environment variable (see the XDG Base Directory Specification).

The chocolate-doom-setup(6) tool provides a simple to use front-end for editing default.cfg.

## FILE FORMAT
The file is a plain-text file, consisting of a list of configuration options and their values, separated by whitespace. Each option is stored on a separate line. Options have different types; an option may have either an integer, floating point or string value. If the option is of a string type, the value is surrounded by quotes (").

For example:

```
integer_value                1
integer_value2               1
floating_point_value         4.2
string_value                 "hello world"
```

Invalid lines or comments in the file will be ignored, but it is advisable not to put them in the file; the file is rewritten from scratch every time the game exits, so any invalid lines or comments will be lost.

Some options are used for keyboard key bindings; these are stored as integer values containing the keyboard scan code of the key to be bound to. Boolean values are also stored as integers, with a value of zero usually indicating "false" and a non-zero value indicating "true".

## CONFIGURATION VARIABLES
mouse_sensitivity

Mouse sensitivity. This value is used to multiply input mouse movement to control the effect of moving the mouse. The "normal" maximum value available for this through the in-game options menu is 9. A value of 31 or greater will cause the game to crash when entering the options menu.

sfx_volume

Volume of sound effects, range 0-15.

music_volume

Volume of in-game music, range 0-15.

show_messages

If non-zero, messages are displayed on the heads-up display in the game ("picked up a clip", etc). If zero, these messages are not displayed.

key_right

Keyboard key to turn right.

key_left

Keyboard key to turn left.

key_up

Keyboard key to move forward.

key_down

Keyboard key to move backward.

key_strafeleft

Keyboard key to strafe left.

key_straferight

Keyboard key to strafe right.

key_fire

Keyboard key to fire the currently selected weapon.

key_use

Keyboard key to "use" an object, eg. a door or switch.

key_strafe

Keyboard key to turn on strafing. When held down, pressing the key to turn left or right causes the player to strafe left or right instead.

key_speed

Keyboard key to make the player run.

use_mouse

If non-zero, mouse input is enabled. If zero, mouse input is disabled.

mouseb_fire

Mouse button to fire the currently selected weapon.

mouseb_strafe

Mouse button to turn on strafing. When held down, the player will strafe left and right instead of turning left and right.

mouseb_forward

Mouse button to move forward.

mouseb_speed

Mouse button to turn on running. When held down, the player will run while moving.

use_joystick

If non-zero, joystick input is enabled.

joyb_fire

Joystick virtual button that fires the current weapon.

joyb_strafe

Joystick virtual button that makes the player strafe while held down.

joyb_use

Joystick virtual button to "use" an object, eg. a door or switch.

joyb_speed

Joystick virtual button that makes the player run while held down. If this has a value of 20 or greater, the player will always run, even if use_joystick is 0.

screenblocks

Screen size, range 3-11. A value of 11 gives a full-screen view with the status bar not displayed. A value of 10 gives a full-screen view with the status bar displayed.

detaillevel

Screen detail. Zero gives normal "high detail" mode, while a non-zero value gives "low detail" mode.

snd_channels

Number of sounds that will be played simultaneously.

snd_musicdevice

Music output device. A non-zero value gives MIDI sound output, while a value of zero disables music.

snd_sfxdevice

Sound effects device. A value of zero disables in-game sound effects, a value of 1 enables PC speaker sound effects, while a value in the range 2-9 enables the "normal" digital sound effects.

snd_sbport

SoundBlaster I/O port. Unused.

snd_sbirq

SoundBlaster IRQ. Unused.

snd_sbdma

SoundBlaster DMA channel. Unused.

snd_mport

Output port to use for OPL MIDI playback. Unused.

usegamma

Gamma correction level. A value of zero disables gamma correction, while a value in the range 1-4 gives increasing levels of gamma correction.

chatmacro0

Multiplayer chat macro: message to send when alt+0 is pressed.

chatmacro1

Multiplayer chat macro: message to send when alt+1 is pressed.

chatmacro2

Multiplayer chat macro: message to send when alt+2 is pressed.

chatmacro3

Multiplayer chat macro: message to send when alt+3 is pressed.

chatmacro4

Multiplayer chat macro: message to send when alt+4 is pressed.

chatmacro5

Multiplayer chat macro: message to send when alt+5 is pressed.

chatmacro6

Multiplayer chat macro: message to send when alt+6 is pressed.

chatmacro7

Multiplayer chat macro: message to send when alt+7 is pressed.

chatmacro8

Multiplayer chat macro: message to send when alt+8 is pressed.

chatmacro9

Multiplayer chat macro: message to send when alt+9 is pressed.

## SEE ALSO
chocolate-doom(6), chocolate-doom.cfg(5), chocolate-doom-setup(6)