xaizek / vifm (License: GPLv2+) (since 2018-12-07)
Vifm is a file manager with curses interface, which provides Vi[m]-like environment for managing objects within file systems, extended with some useful ideas from mutt.
Commit a69026461568b1f91199b9cd3038c02577366d1d

Add index of Lua API to the documentation
Author: xaizek
Author date (UTC): 2024-12-01 22:24
Committer name: xaizek
Committer date (UTC): 2024-12-01 22:24
Parent(s): e2acde205a249d6228197fc7a945c8881652ff9b
Signing key: 99DC5E4DB05F6BE2
Tree: 2eca12f3a137ab9aa5e0ff2ac65ec1d27b6f43c0
File Lines added Lines deleted
ChangeLog.LuaAPI 2 0
data/vim/doc/app/vifm-lua.txt 127 0
src/tags.c 1 0
File ChangeLog.LuaAPI changed (mode: 100644) (index 2ee8566eb..e688217c5)
... ... documented in the regular ChangeLog.
61 61
62 62 Added VifmView:loadcustom() that sets list of paths as a custom view. Added VifmView:loadcustom() that sets list of paths as a custom view.
63 63
64 Added index of Lua API to the documentation for easier overview/lookup.
65
64 66 Made VifmJob:errors() wait for receiving errors if the job has finished. Made VifmJob:errors() wait for receiving errors if the job has finished.
65 67
66 68 Fixed jobs created via vifm.startjob() being displayed with "UNKNOWN" for Fixed jobs created via vifm.startjob() being displayed with "UNKNOWN" for
File data/vim/doc/app/vifm-lua.txt changed (mode: 100644) (index 25cac3052..2e868fab2)
... ... Current API version: v0.1.0
35 35 |vifm-l_VifmJob| `VifmJob` type. |vifm-l_VifmJob| `VifmJob` type.
36 36 |vifm-l_VifmTab| `VifmTab` type. |vifm-l_VifmTab| `VifmTab` type.
37 37 |vifm-l_VifmView| `VifmView` type. |vifm-l_VifmView| `VifmView` type.
38 |vifm-lua-index| Index of all Vifm entities in the API.
38 39
39 40 -------------------------------------------------------------------------------- --------------------------------------------------------------------------------
40 41 *vifm-lua-status* *vifm-lua-status*
 
... ... Possible fields of {entries}:
1608 1609 Return:~ Return:~
1609 1610 Number of new unselected entries. Number of new unselected entries.
1610 1611
1612 --------------------------------------------------------------------------------
1613 *vifm-lua-index*
1614
1615 vifm (table) |vifm-l_vifm|
1616 vifm.addcolumntype({column}) |vifm-l_vifm.addcolumntype()|
1617 vifm.addhandler({handler}) |vifm-l_vifm.addhandler()|
1618 vifm.currview() |vifm-l_vifm.currview()|
1619 vifm.errordialog({title}, {msg}) |vifm-l_vifm.errordialog()|
1620 vifm.escape({what}) |vifm-l_vifm.escape()|
1621 vifm.executable({what}) |vifm-l_vifm.executable()|
1622 vifm.exists({path}) |vifm-l_vifm.exists()|
1623 vifm.expand({str}) |vifm-l_vifm.expand()|
1624 vifm.fnamemodify({path}, {mods}[, {base}]) |vifm-l_vifm.fnamemodify()|
1625 vifm.input({info}) |vifm-l_vifm.input()|
1626 vifm.makepath({path}) |vifm-l_vifm.makepath()|
1627 vifm.otherview() |vifm-l_vifm.otherview()|
1628 vifm.run({info}) |vifm-l_vifm.run()|
1629 vifm.startjob({job}) |vifm-l_vifm.startjob()|
1630 vifm.stdout() |vifm-l_vifm.stdout()|
1631
1632 vifm.abbrevs (table) |vifm-l_vifm.abbrevs|
1633 vifm.abbrevs.add({abbrev}) |vifm-l_vifm.abbrevs.add()|
1634
1635 vifm.cmds (table) |vifm-l_vifm.cmds|
1636 vifm.cmds.add({cmd}) |vifm-l_vifm.cmds.add()|
1637 vifm.cmds.command({cmd}) |vifm-l_vifm.cmds.command()|
1638 vifm.cmds.delcommand({name}) |vifm-l_vifm.cmds.delcommand()|
1639
1640 vifm.events (table) |vifm-l_vifm.events|
1641 vifm.events.listen({event}) |vifm-l_vifm.events.listen()|
1642
1643 vifm.fs (table) |vifm-l_vifm.fs|
1644 vifm.fs.cp({from}, {to}, {onconflict}) |vifm-l_vifm.fs.cp()|
1645 vifm.fs.ln({path}, {target}) |vifm-l_vifm.fs.ln()|
1646 vifm.fs.mkdir({path}, {onmissingparent}) |vifm-l_vifm.fs.mkdir()|
1647 vifm.fs.mkfile({path}) |vifm-l_vifm.fs.mkfile()|
1648 vifm.fs.mv({from}, {to}, {onconflict}) |vifm-l_vifm.fs.mv()|
1649 vifm.fs.rm({path}) |vifm-l_vifm.fs.rm()|
1650 vifm.fs.rmdir({path}) |vifm-l_vifm.fs.rmdir()|
1651
1652 vifm.keys (table) |vifm-l_vifm.keys|
1653 vifm.keys.add({key}) |vifm-l_vifm.keys.add()|
1654
1655 vifm.opts (table) |vifm-l_vifm.opts|
1656 vifm.opts.global (table) |vifm-l_vifm.opts.global|
1657
1658 vifm.plugin (table) |vifm-l_vifm.plugin|
1659 vifm.plugin.name (string) |vifm-l_vifm.plugin.name|
1660 vifm.plugin.path (string) |vifm-l_vifm.plugin.path|
1661 vifm.plugin.require({modname}) |vifm-l_vifm.plugin.require()|
1662
1663 vifm.plugins (table) |vifm-l_vifm.plugins|
1664 vifm.plugins.all (table) |vifm-l_vifm.plugins.all|
1665
1666 vifm.sb (table) |vifm-l_vifm.sb|
1667 vifm.sb.error({msg}) |vifm-l_vifm.sb.error()|
1668 vifm.sb.info({msg}) |vifm-l_vifm.sb.info()|
1669 vifm.sb.quick({msg}) |vifm-l_vifm.sb.quick()|
1670
1671 vifm.sessions (table) |vifm-l_vifm.sessions|
1672 vifm.sessions.current() |vifm-l_vifm.sessions.current|
1673
1674 vifm.tabs (table) |vifm-l_vifm.tabs|
1675 vifm.tabs.get([{query}]) |vifm-l_vifm.tabs.get()|
1676 vifm.tabs.getcount([{query}]) |vifm-l_vifm.tabs.getcount()|
1677 vifm.tabs.getcurrent([{query}]) |vifm-l_vifm.tabs.getcurrent()|
1678
1679 vifm.version (table) |vifm-l_vifm.version|
1680 vifm.version.api.atleast({major}, {minor}, {patch})
1681 |vifm-l_vifm.version.api.atleast()|
1682 vifm.version.api.has({feature}) |vifm-l_vifm.version.api.has()|
1683 vifm.version.api.major (integer) |vifm-l_vifm.version.api.major|
1684 vifm.version.api.minor (integer) |vifm-l_vifm.version.api.minor|
1685 vifm.version.api.patch (integer) |vifm-l_vifm.version.api.patch|
1686 vifm.version.app.str (string) |vifm-l_vifm.version.app.str|
1687
1688 VifmEntry (type) |vifm-l_VifmEntry|
1689 VifmEntry.atime (integer) |vifm-l_VifmEntry.atime|
1690 VifmEntry.classify (table) |vifm-l_VifmEntry.classify|
1691 VifmEntry.ctime (integer) |vifm-l_VifmEntry.ctime|
1692 VifmEntry.folded (boolean) |vifm-l_VifmEntry.folded|
1693 VifmEntry.isdir (boolean) |vifm-l_VifmEntry.isdir|
1694 VifmEntry.location (string) |vifm-l_VifmEntry.location|
1695 VifmEntry.match (boolean) |vifm-l_VifmEntry.match|
1696 VifmEntry.matchend (integer) |vifm-l_VifmEntry.matchend|
1697 VifmEntry.matchstart (integer) |vifm-l_VifmEntry.matchstart|
1698 VifmEntry.mtime (integer) |vifm-l_VifmEntry.mtime|
1699 VifmEntry.name (string) |vifm-l_VifmEntry.name|
1700 VifmEntry.selected (boolean) |vifm-l_VifmEntry.selected|
1701 VifmEntry.size (integer) |vifm-l_VifmEntry.size|
1702 VifmEntry.type (string) |vifm-l_VifmEntry.type|
1703 VifmEntry:gettarget() |vifm-l_VifmEntry.gettarget()|
1704 VifmEntry:mimetype() |vifm-l_VifmEntry.mimetype()|
1705
1706 VifmJob (type) |vifm-l_VifmJob|
1707 VifmJob:errors() |vifm-l_VifmJob:errors()|
1708 VifmJob:exitcode() |vifm-l_VifmJob:exitcode()|
1709 VifmJob:pid() |vifm-l_VifmJob:pid()|
1710 VifmJob:stdin() |vifm-l_VifmJob:stdin()|
1711 VifmJob:stdout() |vifm-l_VifmJob:stdout()|
1712 VifmJob:terminate() |vifm-l_VifmJob:terminate()|
1713 VifmJob:wait() |vifm-l_VifmJob:wait()|
1714
1715 VifmTab (type) |vifm-l_VifmTab|
1716 VifmTab:getlayout() |vifm-l_VifmTab:getlayout()|
1717 VifmTab:getname() |vifm-l_VifmTab:getname()|
1718 VifmTab:getview([{query}]) |vifm-l_VifmTab:getview()|
1719
1720 VifmView (type) |vifm-l_VifmView|
1721 VifmView.currententry (integer) |vifm-l_VifmView.currententry|
1722 VifmView.cursor (table) |vifm-l_VifmView.cursor|
1723 VifmView.custom (table) |vifm-l_VifmView.custom|
1724 VifmView.cwd (string) |vifm-l_VifmView.cwd|
1725 VifmView.entrycount (integer) |vifm-l_VifmView.entrycount|
1726 VifmView.locopts (table) |vifm-l_VifmView.viewopts|
1727 VifmView.viewopts (table) |vifm-l_VifmView.locopts|
1728 VifmView:cd({path}) |vifm-l_VifmView:cd()|
1729 VifmView:entries() |vifm-l_VifmView:entries()|
1730 VifmView:entry({index}) |vifm-l_VifmView:entry()|
1731 VifmView:focus() |vifm-l_VifmView:focus()|
1732 VifmView:gotopath({path}) |vifm-l_VifmView:gotopath()|
1733 VifmView:loadcustom({info}) |vifm-l_VifmView:loadcustom()|
1734 VifmView:select({entries}) |vifm-l_VifmView:select()|
1735 VifmView:selected() |vifm-l_VifmView:selected()|
1736 VifmView:unselect({entries}) |vifm-l_VifmView:unselect()|
1737
1611 1738 -------------------------------------------------------------------------------- --------------------------------------------------------------------------------
1612 1739 vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:sw=4:ft=help:norl: vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:sw=4:ft=help:norl:
File src/tags.c changed (mode: 100644) (index 6c9440851..925c11039)
... ... const char *tags[] = {
814 814 "vifm-lua-events", "vifm-lua-events",
815 815 "vifm-lua-evolution", "vifm-lua-evolution",
816 816 "vifm-lua-handlers", "vifm-lua-handlers",
817 "vifm-lua-index",
817 818 "vifm-lua-libs", "vifm-lua-libs",
818 819 "vifm-lua-loading", "vifm-lua-loading",
819 820 "vifm-lua-plugins", "vifm-lua-plugins",
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/vifm

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/vifm

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master