summaryrefslogtreecommitdiff
path: root/docs/libnm/libnm-docs.xml
Commit message (Collapse)AuthorAgeFilesLines
* docs: include the license boilerplate instead of full GPL textLubomir Rintel2019-09-101-1/+39
| | | | | | | | What's actually needed here is an explaination of how the license applies along with the explanation where to find the full text. Also, the libnm documentation was lacking the licensing information altogether. Fix fixes it too.
* libnm-core: add ovs-dpdk settingLubomir Rintel2019-06-141-0/+1
|
* libnm,cli: add NMSettingWireGuardThomas Haller2019-02-221-0/+1
| | | | | | | | | | | | | | For now only add the core settings, no peers' data. To support peers and the allowed-ips of the peers is more complicated and will be done later. It's more complicated because these are nested lists (allowed-ips) inside a list (peers). That is quite unusual and to conveniently support that in D-Bus API, in keyfile format, in libnm, and nmcli, is a effort. Also, it's further complicated by the fact that each peer has a secret (the preshared-key). Thus we probably need secret flags for each peer, which is a novelty as well (until now we require a fixed set of secrets per profile that is well known).
* wifi-p2p: rename files for consistent Wi-Fi P2P namingThomas Haller2019-02-011-4/+4
| | | | | | | | | | | | | | | | | | | | | | | We named the types inconsistently: - "p2p-wireless" ("libnm-core/nm-setting-p2p-wireless.h") - "p2p" ("libnm/nm-p2p-peer.h") - "p2p-wifi" ("src/devices/wifi/nm-device-p2p-wifi.h") It seems to me, "libnm/nm-p2p-peer.h" should be qualified with a "Wi-Fi" specific name. It's not just peer-to-peer, it's Wi-Fi P2P. Yes, there is an inconsistency now, because there is already "libnm/nm-access-point.h". It seems to me (from looking at the internet), that the name "Wi-Fi P2P" is more common than "P2P Wi-Fi" -- although both are used. There is also the name "Wi-Fi Direct". But it's not clear which name should be preferred here, so stick to "Wi-Fi P2P". In this first commit only rename the files. The following commit will rename the content.
* libnm: Add NMDeviceP2PWifiBenjamin Berg2019-01-271-0/+1
|
* libnm: Add class to handle P2P peersBenjamin Berg2019-01-271-0/+1
| | | | | This adds the introspection data and P2P peer handling to libnm. To be usable the P2P device handling is also needed.
* core: Add basic P2P Wi-Fi SettingsBenjamin Berg2019-01-271-0/+1
| | | | | The support is rather basic and only allows connecting to a specific peer. However, this is actually already enough for many usecases.
* build: fix check-docs.sh for out-of-tree buildsThomas Haller2018-10-251-7/+0
| | | | Fixes: 7a59cd274485e4c0345c563d48e516967630d7f0
* docs: misc. typos pt2luz.paz2018-09-171-2/+2
| | | | | | | | | | | | | | | | | | | | | Remainder of typos found using `codespell -q 3 --skip="./shared,./src/systemd,*.po" -I ../NetworkManager-word-whitelist.txt` whereby whitelist consists of: ``` ans busses cace cna conexant crasher iff liftime creat nd sav technik uint ``` https://github.com/NetworkManager/NetworkManager/pull/205
* all: point git references to the GitLab instanceLubomir Rintel2018-08-271-1/+1
| | | | https://gitlab.freedesktop.org/NetworkManager/NetworkManager/merge_requests/2
* all: add 'match' settingBeniamino Galvani2018-08-111-0/+1
| | | | | | | Add a new 'match' setting containing properties to match a connection to devices. At the moment only the interface-name property is present and, contrary to connection.interface-name, it allows the use of wildcards.
* libnm, cli, ifcfg-rh: add NMSettingEthtool settingThomas Haller2018-08-101-0/+1
| | | | | | | | | | | | | | | | | | | Note that in NetworkManager API (D-Bus, libnm, and nmcli), the features are called "feature-xyz". The "feature-" prefix is used, because NMSettingEthtool possibly will gain support for options that are not only -K|--offload|--features, for example -C|--coalesce. The "xzy" suffix is either how ethtool utility calls the feature ("tso", "rx"). Or, if ethtool utility specifies no alias for that feature, it's the name from kernel's ETH_SS_FEATURES ("tx-tcp6-segmentation"). If possible, we prefer ethtool utility's naming. Also note, how the features "feature-sg", "feature-tso", and "feature-tx" actually refer to multiple underlying kernel features at once. This too follows what ethtool utility does. The functionality is not yet implemented server-side.
* libnm: introduce NMDeviceWireGuardJavier Arteaga2018-08-061-0/+1
|
* libnm-core: add SR-IOV settingBeniamino Galvani2018-07-111-0/+1
| | | | Add a setting containing SR-IOV parameters.
* docs: provide soft descriptions for NM{Simple,Remote}ConnectionLubomir Rintel2018-06-281-1/+1
| | | | ...and order them on more logical places in the libnm manual.
* docs: include missing documentation in libnm and D-Bus docsLubomir Rintel2018-06-281-5/+31
| | | | Check that we don't repeat the omission in future.
* docs: update copyright yearLubomir Rintel2018-06-281-0/+1
|
* docs/libnm: add some more documentationlr/api-docsLubomir Rintel2017-03-171-18/+124
|
* docs: update yearsLubomir Rintel2017-03-021-1/+6
|
* docs: add missing links to dummy and macsec device/settingBeniamino Galvani2017-02-231-0/+4
| | | | | Fixes: b42f780e045c69e6b2c350dcd6de760c673a78e0 Fixes: d252a99fa25359e3795abcacfae08c76dc5386b8
* docs: don't set the online-location attributeLubomir Rintel2016-04-081-1/+1
| | | | | It causes the links to be based on a latest online version rather than on the current one.
* docs: add missing documentation for settings and devicesJiří Klimeš2015-12-181-1/+9
|
* libnm: rename NMSecretAgent to NMSecretAgentOldDan Winship2014-11-211-1/+1
| | | | | | As with NMVpnPluginOld, rename NMSecretAgent to NMSecretAgentOld, to leave the name "NMSecretAgent" open for a new-and-improved version in NM 1.2.
* libnm, docs: docs fixesDan Winship2014-11-071-0/+10
| | | | | | | | | | Update the docs build to include and exclude the correct files. Fill in some missing documentation, and fix problems in the existing docs. (In particular, "<" can't appear as a literal in documentation, so change it to "&lt;". Also, "PKCS#12" has to be written as "PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a type named "12".)
* libnm: create NMDhcpConfig as parent of NMDhcp4Config and NMDhcp6ConfigDan Winship2014-11-071-2/+1
| | | | | As with NMIP4Config and NMIP6Config, merge the two DHCP config classes into one in the public API.
* libnm: create NMIPConfig as parent of NMIP4Config and NMIP6ConfigDan Winship2014-11-071-2/+1
| | | | | | | Create NMIPConfig as the parent of NMIP4Config and NMIP6Config, and remove the two subclasses from the public API; while it's convenient to still have both internally, they are now identical to the outside world.
* libnm-core, all: merge IPv4 and IPv6 address/route typesDan Winship2014-11-071-0/+1
| | | | | | Merge NMIP4Address and NMIP6Address into NMIPAddress, and NMIP4Route and NMIP6Route into NMIPRoute. The new types represent IP addresses as strings, rather than in binary, and so are address-family agnostic.
* libnm: rename NMVpnPlugin to NMVpnPluginOldDan Winship2014-10-281-7/+0
| | | | | | | | | | | | Rename libnm's NMVpnPlugin to NMVpnPluginOld, in preparation for having a new-and-improved NMVpnPlugin in NM 1.2. Also remove it from NM-1.0.gir. Make nm-vpn-plugin-old.h be separately includable, since it's not included from NetworkManager.h, and we probably don't want it to be. Remove NMVpnPlugin, NMVpnPluginUiInterface, and nm-vpn-plugin-utils from the docs, since they're basically undocumented anyway.
* libnm: merge NMRemoteSettings into NMClientDan Winship2014-10-101-1/+0
| | | | | Make NMRemoteSettings internal and have NMClient wrap all of its APIs, just like it does with NMManager.
* libnm: fix NMIP4Config/NMIP6Config addresses/routes propertiesDan Winship2014-09-041-1/+0
| | | | | | | | | | | | | | | | The docs for NMIP4Config:addresses and NMIP4Config:routes claimed that they were GPtrArrays of NMIP4Address/NMIP4Route, but get_property() was actually trying to set them the D-Bus representation type, and it was failing anyway because it used g_value_set_boxed() on a parameter that was declared GParamSpecPointer. Fix it to use a GPtrArray-valued property, and set it to the right thing. NMIP6Config did the right thing with its :addresses and :routes properties, but was using custom types (NM_TYPE_IP6_ADDRESS_OBJECT_ARRAY and NM_TYPE_IP6_ROUTE_OBJECT_ARRAY). Make it use G_TYPE_PTR_ARRAY instead. nm-types.c, nm-types.h, and nm-types-private.h are now empty, and so can be dropped.
* docs: add libnm documentationDan Winship2014-08-011-0/+161
Add docs infrastructure