diff options
Diffstat (limited to 'lib/Hal')
| -rw-r--r-- | lib/Hal/Cdroms.pm | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/lib/Hal/Cdroms.pm b/lib/Hal/Cdroms.pm index d8e6d8f..19d8263 100644 --- a/lib/Hal/Cdroms.pm +++ b/lib/Hal/Cdroms.pm @@ -3,6 +3,7 @@ package Hal::Cdroms; our $VERSION = 0.04; # Copyright (C) 2008 Mandriva +# Copyright (C) 2020 Mageia # # This program is free software; You can redistribute it and/or modify # it under the same terms as Perl itself. Either: @@ -20,7 +21,7 @@ our $VERSION = 0.04; =head1 NAME -Hal::Cdroms - access cdroms through HAL and D-Bus +Hal::Cdroms - access removable media containing CD filesystems through UDisks2 and D-Bus =head1 SYNOPSIS @@ -39,7 +40,8 @@ Hal::Cdroms - access cdroms through HAL and D-Bus =head1 DESCRIPTION -Access cdroms through HAL and D-Bus. +Access removable media containing CD filesystems (iso9660 and udf) through +UDisks2 and D-Bus. This includes CD-ROMS, DVD-ROMS, and USB flash drives. =cut @@ -66,7 +68,7 @@ sub new { =head2 $cdroms->list -Returns the list of C<udisks_path> of the cdroms (mounted or not). +Return the list of C<udisks_path> of the removable media (mounted or not). =cut @@ -156,7 +158,7 @@ sub ensure_mounted { =head2 $cdroms->mount($udisks_path) -Mount the C<udisks_path> through HAL +Mount the C<udisks_path> through UDisks2. Return the mount point associated to the C<udisks_path>, or undef it cannot be mounted successfully (see $cdroms->{error}). =cut @@ -173,7 +175,8 @@ sub mount { =head2 $cdroms->unmount($udisks_path) -Unmount the C<udisks_path>. Return true on success (see $cdroms->{error} on failure) +Unmount the C<udisks_path> through UDisks2. +Return true on success (see $cdroms->{error} on failure) =cut @@ -186,7 +189,7 @@ sub unmount { =head2 $cdroms->eject($udisks_path) -Ejects the C<udisks_path>. Return true on success (see $cdroms->{error} on failure) +Eject the C<udisks_path>. Return true on success (see $cdroms->{error} on failure). =cut @@ -200,8 +203,8 @@ sub eject { =head2 $cdroms->wait_for_insert([$timeout]) -Waits until a cdrom is inserted. -Returns the inserted C<udisks_path> on success. Otherwise returns undef. +Wait until media containing a CD filesystem is inserted. +Return the inserted C<udisks_path> on success. Otherwise return undef. You can give an optional timeout in milliseconds. @@ -224,8 +227,8 @@ sub wait_for_insert { =head2 $cdroms->wait_for_mounted([$timeout]) -Waits until a cdrom is inserted and mounted by a volume manager (eg: gnome-volume-manager). -Returns the mounted C<udisks_path> on success. Otherwise returns undef. +Wait until media containing a CD filesystem is inserted and mounted by a volume manager (eg: gnome-volume-manager). +Return the mounted C<udisks_path> on success. Otherwise return undef. You can give an optional timeout in milliseconds. @@ -286,5 +289,6 @@ sub member { my $e = shift; foreach (@_) { $e eq $_ and return 1 } 0 } =head1 AUTHOR Pascal Rigaux <pixel@mandriva.com> +Martin Whitaker <martinw@mageia.org> =cut |