Homec4science
Diffusion SBCP High-Level Driver (master) Browse

libsbcp/man/sbcp-config.in
10a90dc3c6dfmaster

Last Change
Raw File

sbcp-config.in
View Options

.\" Copyright 2013 Alexandre Tuleu <alexandre.tuleu.2005@polytechnique.org>
.\" All rights reserved.
.TH "SBCP\-CONFIG" 1 "January 2013" "libsbcp @VERSION_STRING@" "libsbcp manual"
.SH "NAME"
sbcp-config \- helper tool to manage configuration file for sbcp buses
.SH "SYNOPSIS"
.sp
.nf
\fIsbcp-config\fR [\-\-system|\-\-global] [\-l|\-\-list\-all]
\fIsbcp-config\fR [\-\-system|\-\-global] [\-e|\-\-edit]
\fIsbcp-config\fR [\-\-system|\-\-global] [\-a|\-\-add name]
.fi
.sp
.SH "DESCRIPTION"
.sp
With this command you can list/edit/add SBCP bus definition on your system
.sp
SBCP buses are defined through the sbcp.config files. These file are expected to be in certain locations to be used by other tools based on libsbcp, like sbcp-scanner, sbcp-id-modifier and sbcp-register-io :
.sp
.nf
\fI/etc/sbcp.config\fR : system wide configuration
\fI$HOME/.sbcp.config\fR : user wide configuration (global)
\fI$PWD/sbcp.config\fR : directory wide configuration
.fi
.sp
.SH "OPTIONS"
.PP
\-\-global
.RS 4
Load the configuration up to the global level, skipping directry wise configuration. --edit/--all will then affect only user wide configuration file.
.RE
.PP
\-\-system
.RS 4
Same tha \-\-global but only load the system wide file.
.RE
.PP
\-\-list\-all,\-l
.RS 4
List all of the available bus, with some information, like interface, baudrate, master ID and current runtime status.
.RE
.PP
\-\-edit,\-e
.RS 4
Edit the directory wise configuration level using $EDITOR. If \-\-global or \-\-system is specified, edit that file instead.
.RE
.PP
\-\-add,\-a <name>
.RS 4
Create a new default configuration named <name> for directory wise configuration, and edit it. If \-\-global or \-\-system is specified, edit that file instead.
.RE
.SH "BUGS"
To see or report bugs please use the bug tracker at https://redmine.amarsi-project.eu/projects/libsbcp/issues
.SH "AUTHOR"
Alexandre Tuleu <alexandre.tuleu.2005@polytechnique.org>
.SH "SEE ALSO"
.BR sbcp-scanner(1),
.BR sbcp-register-io(1),
.BR sbcp-id-modifier(1)
c4science · Help