TnSb/wofi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

v1.1.2: fixed typos in man pages

Browse Source
This commit is contained in:
Scoopta 2020-03-09 22:37:36 -07:00
parent f016f32f7a
commit 1dd640e283
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/wofi.1
View File

@ -69,7 +69,7 @@ Specifies the term to use when running a program in a terminal. This overrides t
Runs wofi in password mode with an optional password character to use. If no character is specified * is used by default. Runs wofi in password mode with an optional password character to use. If no character is specified * is used by default.
.TP .TP
.B \-e, \-\-exec\-search .B \-e, \-\-exec\-search
Activiating a seach with enter will execute the search not the first result. Activiating a search with enter will execute the search not the first result.
.TP .TP
.B \-b, \-\-hide\-scroll .B \-b, \-\-hide\-scroll
Hides the scroll bars. Hides the scroll bars.

12
man/wofi.3
View File

@ -15,7 +15,7 @@ The following list of functions are the functions which can be defined inside of
.TP .TP
.B void init(struct mode* mode, struct map* config) .B void init(struct mode* mode, struct map* config)
Definining this function is required. This function is called to setup your plugin and provide it with serveral pointers which are described below. Defining this function is required. This function is called to setup your plugin and provide it with several pointers which are described below.
.B struct mode* mode .B struct mode* mode
\- used to identify your mode, it is passed to a large number of the API functions to identify your mode. \- used to identify your mode, it is passed to a large number of the API functions to identify your mode.
@ -25,23 +25,23 @@ Definining this function is required. This function is called to setup your plug
.TP .TP
.B const char** get_arg_names(void) .B const char** get_arg_names(void)
Definining this function is optional. This function is called to get an array of config options which can be set by the user. All of these options have the name of your mode prefixed on the front so if your array is for example \fB{"opt1", "opt2"}\fR the config options defined will be \fBmode-opt1=\fIvalue\fR and \fBmode-opt2=\fIvalue\fR where mode is the name of the shared object. Defining this function is optional. This function is called to get an array of config options which can be set by the user. All of these options have the name of your mode prefixed on the front so if your array is for example \fB{"opt1", "opt2"}\fR the config options defined will be \fBmode-opt1=\fIvalue\fR and \fBmode-opt2=\fIvalue\fR where mode is the name of the shared object.
.TP .TP
.B size_t get_arg_count(void) .B size_t get_arg_count(void)
Definining this function is optional. This function is called to get the number of arguments returned by \fBget_arg_names(void)\fR. Defining this function is optional. This function is called to get the number of arguments returned by \fBget_arg_names(void)\fR.
.TP .TP
.B void exec(const char* cmd) .B void exec(const char* cmd)
Definining this function is required. This function is called when the user selects an entry. Defining this function is required. This function is called when the user selects an entry.
.B const char* cmd .B const char* cmd
\- The action registered to the selected entry. If your mode allows executing searches directly then this will be the search contents if no matching entries exist. \- The action registered to the selected entry. If your mode allows executing searches directly then this will be the search contents if no matching entries exist.
.TP .TP
.B struct widget* get_widget(void) .B struct widget* get_widget(void)
Definining this function is optional. This function is called to request the next widget to be added. See \fBwofi_create_widget()\fR in \fBwofi\-api(3)\fR on how to obtain a \fBstruct widget*\fR. \fBNULL\fR should be returned to denote no more widgets are available. Defining this function is optional. This function is called to request the next widget to be added. See \fBwofi_create_widget()\fR in \fBwofi\-api(3)\fR on how to obtain a \fBstruct widget*\fR. \fBNULL\fR should be returned to denote no more widgets are available.
.TP .TP
.B bool no_entry(void) .B bool no_entry(void)
Definining this function is optional. This function is called to find out whether or not this mode supports running searches without any matching entries. The default is false, if you wish to allow your mode to take searches directly you must define this and return true. Defining this function is optional. This function is called to find out whether or not this mode supports running searches without any matching entries. The default is false, if you wish to allow your mode to take searches directly you must define this and return true.

6
man/wofi.5
View File

@ -71,7 +71,7 @@ Specifies the term to use when running a program in a terminal. This overrides t
Runs wofi in password mode using the specified character, default is false. Runs wofi in password mode using the specified character, default is false.
.TP .TP
.B exec_search=\fIBOOL\fR .B exec_search=\fIBOOL\fR
If true activiating a seach with enter will execute the search not the first result, default is false. If true activiating a search with enter will execute the search not the first result, default is false.
.TP .TP
.B hide_scroll=\fIBOOL\fR .B hide_scroll=\fIBOOL\fR
If true hides the scroll bars, default is false. If true hides the scroll bars, default is false.
@ -122,7 +122,7 @@ Specifies the size of images in pixels when images are enabled, default is 32.
Specifies the key to use in order to move up. Default is Up(Up arrow). See \fBwofi\-keys\fR(7) for the key codes. Specifies the key to use in order to move up. Default is Up(Up arrow). See \fBwofi\-keys\fR(7) for the key codes.
.TP .TP
.B key_down=\fIKEY\fR .B key_down=\fIKEY\fR
Sepcifies the key to use in order to move down. Default is Down(Down arrow). See \fBwofi\-keys\fR(7) for the key codes. Specifies the key to use in order to move down. Default is Down(Down arrow). See \fBwofi\-keys\fR(7) for the key codes.
.TP .TP
.B key_left=\fIKEY\fR .B key_left=\fIKEY\fR
Specifies the key to use in order to move left. Default is Left(Left arrow). See \fBwofi\-keys\fR(7) for the key codes. Specifies the key to use in order to move left. Default is Left(Left arrow). See \fBwofi\-keys\fR(7) for the key codes.
@ -152,7 +152,7 @@ Specifies whether x and y offsets should be calculated using the global composit
Specifies whether the search bar should be hidden. Default is false. Specifies whether the search bar should be hidden. Default is false.
.SH CSS SELECTORS .SH CSS SELECTORS
Any GTK widget can be selected by using the name of its CSS node, these however might change with updates and are not guarenteed to stay constant. Wofi also provides certain widgets with names and classes which can be referenced from CSS to give access to the most important widgets easily. \fBwofi\fR(7) contains the current widget layout used by wofi so if you want to get into CSS directly using GTK widget names look there for info. Any GTK widget can be selected by using the name of its CSS node, these however might change with updates and are not guaranteed to stay constant. Wofi also provides certain widgets with names and classes which can be referenced from CSS to give access to the most important widgets easily. \fBwofi\fR(7) contains the current widget layout used by wofi so if you want to get into CSS directly using GTK widget names look there for info.
.TP .TP
.B #window .B #window

2
man/wofi.7
View File

@ -68,7 +68,7 @@ bottom_left 7
left 8 left 8
.P .P
The x and y offsets are applied based on layer\-shell anchors which means an x offset can only be applied if wofi is anchored on the x axis, i.e. you can only use an x offset with the top_left, top_right, right, bottom_right, bottom_left, and left locations. center, top, and bottom can't have x offsets as they're not anchored on the x axis. Likewise y offsets can only be applied to top_left, top, top_right, bottom_right, bottom, and bottom_left locations. center, left, and right can't have y offsets because they're not anchored to the y axis. Since center can't have offsets on either as it's not anchored to any axis any x or y offset applied while using center will override the location to top_left for backwards compatiblity reasons seeing as not doing so would simply ignore the offsets anyway. The x and y offsets are applied based on layer\-shell anchors which means an x offset can only be applied if wofi is anchored on the x axis, i.e. you can only use an x offset with the top_left, top_right, right, bottom_right, bottom_left, and left locations. center, top, and bottom can't have x offsets as they're not anchored on the x axis. Likewise y offsets can only be applied to top_left, top, top_right, bottom_right, bottom, and bottom_left locations. center, left, and right can't have y offsets because they're not anchored to the y axis. Since center can't have offsets on either as it's not anchored to any axis any x or y offset applied while using center will override the location to top_left for backwards compatibility reasons seeing as not doing so would simply ignore the offsets anyway.
.SH ORDER .SH ORDER
There are 2 order options currently, default and alphabetical. Default means the entries are displayed in the order they are added by the mode, for all built in modes this is cached items first, followed by other entries in no specific order. Alphabetical means entries are alphabetical sorted period. These orders only affect the order when no search has been entered. Once a search is entered the order is re-arranged based on the current matching preference and this order is ignored. There are 2 order options currently, default and alphabetical. Default means the entries are displayed in the order they are added by the mode, for all built in modes this is cached items first, followed by other entries in no specific order. Alphabetical means entries are alphabetical sorted period. These orders only affect the order when no search has been entered. Once a search is entered the order is re-arranged based on the current matching preference and this order is ignored.