=head1 NAME

ngcp-site - prints the current site name

=head1 SYNOPSIS

B<ngcp-site>

=head1 DESCRIPTION

This program prints the current site name, or B<none> when no site name
has been configured.

This is mostly relevant for multi-site setups, where multiple NGCP
installations work together to provide service, usually as part of
geolocation requirements.

=head1 EXIT STATUS

=over

=item B<0>

Success.

=item B<1>

The B<current> site pathname is not a symlink.

=item B<2>

The B<current> site pathname does not contain a site name, but a relative or
absolute pathname.

=item B<3>

The B<current> site pathname is a dangling symlink.

=item B<4>

The B<current> site pathname is a symlink whose target is not a directory.

=back

=head1 FILES

=over

=item I</etc/ngcp-config/sites/current>

If it exists, this is the symlink pointing to the current site.

=back

=head1 ENVIRONMENT

=over

=item B<NGCP_ROOT>

This variable, if not empty, contains an absolute pathname for the NGCP
specific root directory to prepend to pathnames.

=back

=head1 BUGS AND LIMITATIONS

Please report problems you notice to the Sipwise
Development Team <support@sipwise.com>.

=head1 AUTHOR

Guillem Jover <gjover@sipwise.com>

=head1 LICENSE

Copyright (C) 2022 Sipwise GmbH, Austria

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
