matteo
/
malcontent
1
0
Fork 0
Code Issues Pull Requests 2 Packages Projects Releases Wiki Activity
malcontent/malcontent-client/docs/malcontent-client.8

133 lines
4.0 KiB
Groff
Raw Normal View History

Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
.\" Manpage for malcontent\-client.
.\" Documentation is under the same licence as the malcontent
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\" package.
docs: Update malcontent-client manpage to mention new supported types Mention content types and flatpak refs are also valid for 'check' command arguments. Signed-off-by: Andre Moreira Magalhaes <andre@endlessm.com>
2019-06-13 19:58:08 +02:00
.TH man 8 "13 Jun 2019" "1.1" "malcontent\-client man page"
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.SH NAME
.IX Header "NAME"
Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
malcontent\-client — Parental Controls Access Utility
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.\"
malcontent-client: Rename ‘get’ command to ‘get-app-filter’ There’ll be other types of getting happening soon. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-12-04 16:52:03 +01:00
\fBmalcontent\-client get\-app\-filter [\-q] [\-n] [\fPUSER\fB]
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.PP
malcontent-client: Rename ‘check’ command to ‘check-app-filter’ Since it operates only on the app filter. This updates the documentation too. No compatibility fallback is provided. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:00:52 +01:00
\fBmalcontent\-client check\-app\-filter [\-q] [\-n] [\fPUSER\fB] \fPARG\fB
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.\"
Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
\fBmalcontent\-client\fP is a utility for querying and updating the
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
parental controls settings for users on the system. It will typically require
adminstrator access to do anything more than query the current user’s parental
controls.
.PP
It communicates with accounts-service, which stores parental controls data.
.PP
Its first argument is a command to run. Currently, the only supported commands
malcontent-client: Rename ‘check’ command to ‘check-app-filter’ Since it operates only on the app filter. This updates the documentation too. No compatibility fallback is provided. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:00:52 +01:00
are \fBget\-app\-filter\fP and \fBcheck\-app\-filter\fP.
docs: Mention that malcontent-client command line API is unstable It might be stable one day, but while the functionality of libmalcontent is growing, the command line tooling will continue to change. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-17 12:24:32 +01:00
.PP
The command line API and output format are unstable and likely to change in
future versions of \fBmalcontent\-client\fP.
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
malcontent-client: Rename ‘get’ command to ‘get-app-filter’ There’ll be other types of getting happening soon. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-12-04 16:52:03 +01:00
.SH \fBget\-app\-filter\fP OPTIONS
.IX Header "get\-app\-filter OPTIONS"
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.IP "\fBUSER\fP"
Username or ID of the user to get the app filter for. If not specified, the
current user will be used by default.
.\"
.IP "\fB\-q\fP, \fB\-\-quiet\fP"
Only output error messages, and no informational messages, as the operation
progresses. (Default: Output informational messages.)
.\"
.IP "\fB\-n\fP, \fB\-\-no\-interactive\fP"
Do not allow interactive authorization with polkit. If this is needed to
complete the operation, the operation will fail. (Default: Allow interactive
authorization.)
.\"
malcontent-client: Rename ‘check’ command to ‘check-app-filter’ Since it operates only on the app filter. This updates the documentation too. No compatibility fallback is provided. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:00:52 +01:00
.SH \fBcheck\-app\-filter\fP OPTIONS
.IX Header "check\-app\-filter OPTIONS"
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.IP "\fBUSER\fP"
Username or ID of the user to get the app filter for. If not specified, the
current user will be used by default.
.\"
docs: Update malcontent-client manpage to mention new supported types Mention content types and flatpak refs are also valid for 'check' command arguments. Signed-off-by: Andre Moreira Magalhaes <andre@endlessm.com>
2019-06-13 19:58:08 +02:00
.IP "\fBARG\fP"
Path to a program, content type or flatpak ref to check against the app filter,
to see if it is allowed for the specified user.
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.IP "\fB\-q\fP, \fB\-\-quiet\fP"
Only output error messages, and no informational messages, as the operation
progresses. (Default: Output informational messages.)
.\"
.IP "\fB\-n\fP, \fB\-\-no\-interactive\fP"
Do not allow interactive authorization with polkit. If this is needed to
complete the operation, the operation will fail. (Default: Allow interactive
authorization.)
.\"
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.\"
Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
\fBmalcontent\-client\fP supports the standard GLib environment
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
variables for debugging. These variables are \fBnot\fP intended to be used in
production:
.\"
.IP \fI$G_MESSAGES_DEBUG\fP 4
.IX Item "$G_MESSAGES_DEBUG"
This variable can contain one or more debug domain names to display debug output
for. The value \fIall\fP will enable all debug output. The default is for no
debug output to be enabled.
.\"
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.\"
Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
\fBmalcontent\-client\fP may return one of several error codes if it
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
encounters problems.
.\"
.IP "0" 4
.IX Item "0"
No problems occurred. The utility ran and successfully queried the app filter.
malcontent-client: Rename ‘check’ command to ‘check-app-filter’ Since it operates only on the app filter. This updates the documentation too. No compatibility fallback is provided. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:00:52 +01:00
If running the \fBcheck\-app\-filter\fP command, the given path, content type or
flatpak ref was allowed for the given user.
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
.IP "1" 4
.IX Item "1"
Rename project from eos-parental-controls to malcontent Rename the library from libeos-parental-controls to libmalcontent, and the client from eos-parental-controls-client to malcontent-client. This was done using the following mechanical edits, and no other changes: ``` git search-replace -f EPC///MCT git search-replace -f Epc///Mct git search-replace -f epc///mct git search-replace -f eos_parental_controls///malcontent git search-replace -f eos-parental-controls///malcontent git search-replace -f EosParentalControls///Malcontent git search-replace -f 'eos\\-parental\\-controls///malcontent' git search-replace -f 'Since: 0.1.0///Since: 0.2.0' ``` Note that the accounts-service extension interface has *not* been renamed, as that would revert people’s parental controls settings in existing deployments. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-02-26 18:43:56 +01:00
An invalid option was passed to \fBmalcontent\-client\fP on
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
startup.
.\"
.IP "2" 4
.IX Item "2"
The current user was not authorized to query the app filter for the given user.
.\"
.IP "3" 4
.IX Item "3"
malcontent-client: Rename ‘check’ command to ‘check-app-filter’ Since it operates only on the app filter. This updates the documentation too. No compatibility fallback is provided. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:00:52 +01:00
If running the \fBcheck\-app\-filter\fP command, the given path, content type or
flatpak ref was \fInot\fP allowed for the given user.
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.\"
malcontent-client: Improve specificity of exit statuses Add a couple of missing exit statuses (and document them) and convert Malcontent errors to exit statuses more specifically. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2020-01-16 12:20:57 +01:00
.IP "4" 4
.IX Item "4"
Malcontent is disabled at the system level, and hence parental controls are
not enabled or enforced.
.\"
.IP "5" 4
.IX Item "5"
An operation failed and no more specific error information is available.
.\"
eos-parental-controls-client: Add simple client program This allows querying of the parental controls for a given user (or the current user). Includes documentation but no tests yet. Signed-off-by: Philip Withnall <withnall@endlessm.com> https://phabricator.endlessm.com/T23859
2018-10-02 18:03:33 +02:00
.SH BUGS
.IX Header "BUGS"
.\"
Any bugs which are found should be reported on the project website:
.br
\fIhttps://support.endlessm.com/\fP
.\"
.SH AUTHOR
.IX Header "AUTHOR"
.\"
Endless Mobile, Inc.
.\"
.SH COPYRIGHT
.IX Header "COPYRIGHT"
.\"
Copyright © 2018 Endless Mobile, Inc.